Move executable code in separate scripts and add argparse option for … #39
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clement-moulin-frier
requested changes
Mar 13, 2024
There was a problem hiding this comment.
Works great, well done :) I pointed to a few issues in the code, please solve them and then you can directly merge. Also, I recommend that we remove the main bloc at the end of the files when this code is already in the new scripts (better to avoid code duplication). I think it concerns simulator.py and simulator_server.py. But let me know if you don't agree
README.md
Outdated
| ``` | ||
|
|
||
| ### Interact with it from a web interface | ||
|
|
||
| And launch the web interface from another terminal : | ||
|
|
||
| ```bash | ||
| panel serve vivarium/interface/panel_app.py --autoreload | ||
| panel serve scrits/run_interface.py --autoreload |
There was a problem hiding this comment.
Indeed I forgot to remove the main bloc in some old files, thanks for noticing !
vivarium/interface/panel_app.py
Outdated
Comment on lines
282
to
285
| # if __name__ == "__main__": | ||
| # # Serve the app | ||
| # wm = WindowManager() | ||
| # wm.app.servable(title="Vivarium") |
There was a problem hiding this comment.
Maybe remove these commented lines?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…configs
Description
Aims to enhance the organization and usability of the project by restructuring executable scripts and integrating argparse functionality.
Firstly, it relocates executable parts of files in the vivarium directory to the root directory, separating source code from execution scripts for improved clarity and ease of use. For instance, the main execution logic currently embedded within individual files like
vivarium/simulator/simulator.py,vivarium/simulator/grpc_server/simulator_server.pyandvivarium/interface/panel_app.pyare moved to dedicated scripts namedsimulate.py(to run simulations without server mode, on a cluster of GPUs for example),run_server.pyandinterface_app.py(removed panel from the name as we discussed), respectively. This reorganization simplifies command-line usage for script executionSecondly,
argparseoptions are added to executable scripts to define default simulation parameters and enable command-line parameter customization. It allows for easy adjustment of simulation parameters such as max number of agents, box size, and physics parameters without necessitating code modifications in various files. At the moment I only implemented it for the simulator_config, but it could be useful for other arguments as discussed in #35 (especially if we launch simulations in GPU clusters where we don't have access to an IDE).@Marsolo1 also added an option for the logging level to set it with argparse (with a default value of INFO). This way we only define it in the script we run instead of doing so in all the files from which we import functions/classes to run the script.
I also renamed the executable files with more explicit names (starting with 'run'):
interface_app.py-->run_interface.pysimulate.py-->run_simulation.pyAfter a discussion with Clément Romac, I decided to put all the executable script in a directory named
scriptsto make the organization of the project cleaner.For example if you want to run a simulation with 20 agents and 5 objects in a server, run :
Related Issue (if applicable)
#38
How to Test (!! This has been modified !!)
Launch the server
Launch the Panel interface