Skip to content

isaac-gumbrell/scenario_framework_manager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 

Repository files navigation

Read article for better explanation: https://medium.com/@isaacgumbrell_61100/streamline-your-modelling-workflow-small-efforts-now-big-productivity-gains-later-8b4afc47292a

The Scenario Framework Manager is designed to streamline scenario management by automatically organizing input and output data for each model run.  The base folder has two folders: Results and Scenarios. Within Scenarios are multiple folders, one for each scenario. Each scenario folder contains input data for a single execution of the model.

After importing the scenario framework module, initialize a ScenarioFramework object while providing the paths of the Scenarios and Results folders as inputs. from scenario_framework import ScenarioFramework

scenario = ScenarioFramework(scenario_folder_path='', results_folder_path='')

scenario_path, inputs_path, outputs_path = scenario.pick_scenario()

After initializing the ScenarioFramework object, call the pickscenario function, and assign the function's output to inputs_path and outputs_path variables. The console window will now prompt you to pick a scenario. 

Choose the scenario you wish to run by entering its corresponding number and press enter.  You now have paths for both outputs and inputs which can be used throughout the rest of your model without worrying about overwriting data or saving results in the correct place. Both folders are contained within a parent folder representing a single execution of the model. Its name is a combination of the scenario folder's name, and timestamp of when the scenario was executed. This folder is contained within the Results folder. 

The Inputs folder has a fresh copy of all data in the Scenario folder, this is where you will import data from while you continue the rest of the model. The Outputs folder is a fresh directory ready for any outputs.  If you want to make a slight variation of a scenario, you can simply copy the scenario folder. 

About

Scenario Framework Manager is a Python tool for organizing and managing simulation scenarios. It supports selecting scenarios, automates input/output folder setup, and creates timestamped run directories. Ideal for modeling workflows where multiple scenarios need to be configured, managed, and run independently.

Resources

License

Stars

1 star

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages