Skip to content

Commit

Permalink
documented box model options
Browse files Browse the repository at this point in the history
  • Loading branch information
alexjamesgarza committed Apr 27, 2024
1 parent e7df9c5 commit 90901d5
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions src/acom_music_box/music_box_model_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ def __init__(self, chem_step_time, output_step_time, simulation_length, grid="bo
@classmethod
def from_UI_JSON(cls, UI_JSON):
"""
Create a new instance of the BoxModelOptions class from a JSON object.
Create a new instance of the BoxModelOptions class from a JSON object from the MusicBox Interactive UI.
Args:
UI_JSON (dict): A JSON object representing the user interface options.
UI_JSON (dict): A JSON object representing the box model options from the user interface options.
Returns:
BoxModelOptions: A new instance of the BoxModelOptions class.
Expand All @@ -49,6 +49,15 @@ def from_UI_JSON(cls, UI_JSON):

@classmethod
def from_config_JSON(cls, config_JSON):
"""
Create a new instance of the BoxModelOptions class from a JSON object from a configuration JSON.
Args:
UI_JSON (dict): A JSON object representing box model options.
Returns:
BoxModelOptions: A new instance of the BoxModelOptions class.
"""

chem_step_time = convert_time(config_JSON['box model options'], 'chemistry time step')
output_step_time = convert_time(config_JSON['box model options'], 'output time step')
Expand Down

0 comments on commit 90901d5

Please sign in to comment.