Skip to content

Commit

Permalink
documented species list
Browse files Browse the repository at this point in the history
  • Loading branch information
alexjamesgarza committed Apr 27, 2024
1 parent a94fd18 commit d97c0a1
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions src/acom_music_box/music_box_species_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def __init__(self, species=None, relative_tolerance=1.0e-4):
Args:
species (List[Species]): A list of Species instances. Default is an empty list.
relative_tolerance (float): The relative tolerance for the species list. Default is 0.0.
relative_tolerance (float): The relative tolerance for the species list. Default is 1.0e-4.
"""
self.species = species if species is not None else []
self.relative_tolerance = relative_tolerance
Expand All @@ -29,7 +29,7 @@ def from_UI_JSON(cls, UI_JSON):
Create a new instance of the SpeciesList class from a JSON object.
Args:
UI_JSON (dict): A JSON object representing the species list.
UI_JSON (dict): A JSON object from MusicBox Interactive representing the species list.
Returns:
SpeciesList: A new instance of the SpeciesList class.
Expand All @@ -49,6 +49,15 @@ def from_UI_JSON(cls, UI_JSON):

@classmethod
def from_config_JSON(cls, path_to_json, config_JSON):
"""
Create a new instance of the SpeciesList class from a JSON object.
Args:
UI_JSON (dict): A JSON object from a config JSON representing the species list.
Returns:
SpeciesList: A new instance of the SpeciesList class.
"""

species_from_json = []

Expand Down

0 comments on commit d97c0a1

Please sign in to comment.