ModelManagerStudio
Documentation for ModelManagerStudio.
ModelManagerStudio.ReinitPolicy
ModelManagerStudio.get_pcmm_paths
ModelManagerStudio.init_model_manager_gui
ModelManagerStudio.launch
ModelManagerStudio.parse_reinit_policy
ModelManagerStudio.studio_initialize_model_manager
ModelManagerStudio.ReinitPolicy
— TypeReinitPolicy
An enum to specify the reinitialization policy for the Model Manager.
Uses the following values:
ask
: Prompt the user to confirm reinitialization if paths differ.update
: Automatically reinitialize the Model Manager with new paths if they differ.keep
: Keep the existing paths and do not reinitialize.
ModelManagerStudio.get_pcmm_paths
— Methodget_pcmm_paths(args::Vararg{AbstractString})
Get the PhysiCell and data directories from the provided arguments. See launch
for details on how the arguments are interpreted.
ModelManagerStudio.init_model_manager_gui
— Methodinit_model_manager_gui(args::Vararg{AbstractString}; kwargs...)
Internal function to initialize the Model Manager GUI with the specified arguments. Called by launch
.
ModelManagerStudio.launch
— Methodlaunch()
launch(path_to_project::AbstractString)
launch(data_dir::AbstractString, physicell_dir::AbstractString)
Launch the Model Manager Studio GUI for a particular project.
If no arguments are provided, it will initialize the Model Manager within the current working directory, i.e., using data_dir = "./data"
and physicell_dir = "./PhysiCell"
. If a single argument is provided, it will use that as the base directory and append data
and PhysiCell
to it, i.e., data_dir = "$(path_to_project)/data"
and physicell_dir = "$(path_to_project)/PhysiCell"
. If two arguments are provided, they will be used as the data_dir
and physicell_dir
, respectively.
The reinit_policy
keyword argument can be used to specify how the Model Manager should handle reinitialization if the paths differ from the previously initialized paths. See ReinitPolicy
for more options. String or Symbol values can be used for reinit_policy
.
Examples
using ModelManagerStudio
launch() # Launches with default paths in the current directory, i.e., `data_dir = "./data"` and `physicell_dir = "./PhysiCell"`
launch("path/to/project") # Launches with specified project path (will ask if paths differ)
launch("path/to/data", "path/to/PhysiCell"; reinit_policy=:update) # Launches with specified data and PhysiCell directories, updating if paths differ
launch("path/to/data", "path/to/PhysiCell"; reinit_policy="keep") # Launches with specified directories, keeping previous paths if they differ
launch(; reinit_policy=ModelManagerStudio.ask) # Launches with default paths, asking the user to confirm reinitialization if paths differ
ModelManagerStudio.parse_reinit_policy
— Methodparse_reinit_policy(policy::Symbol)
parse_reinit_policy(policy::AbstractString)
Parse the reinitialization policy from a Symbol or String to a ReinitPolicy
enum.
ModelManagerStudio.studio_initialize_model_manager
— Methodstudio_initialize_model_manager(args::Vararg{AbstractString}; reinit_policy=ask)
Internal function to initialize the Model Manager with the specified arguments. Called by init_model_manager_gui
.