pymgipsim.Utilities.simulation_folder

---

Functions

create_simulation_folder	Create a simulation folder and subfolders for figures.
create_simulation_name	Create a simulation name based on the start timestamp.
create_simulation_results_folder	Create a simulation results folder with metadata.
get_most_recent_folder_in_directory	Get the most recent folder in a given directory based on modification time.
load_settings_file
save_to_xls

create_simulation_folder(results_folder_directory: str, simulation_name: str) → str

Create a simulation folder and subfolders for figures.

Parameters: - results_folder_directory: str

Path to the results folder.

• simulation_name: str

  Name of the simulation.

Returns: - str

Path to the created simulation folder.

create_simulation_name(start_time_stamp: str) → str

Create a simulation name based on the start timestamp.

Parameters: - start_time_stamp: str

Start timestamp of the simulation.

Returns: - str

Generated simulation name.

create_simulation_results_folder(results_directory: str) → tuple[str, str, str, str]

Create a simulation results folder with metadata.

Parameters: - results_directory: str

Path to the results directory.

Returns: - tuple

Tuple containing start timestamp, Python system information, simulation name, and folder path.

get_most_recent_folder_in_directory(directory: str) → str

Get the most recent folder in a given directory based on modification time.

Parameters: - directory: str

Directory path.

Returns: - str

Path of the most recent folder.