API Reference

This documentation describes the Python API for MusicBox. For detailed information on the chemistry-related objects and reaction definitions used in MusicBox via MUSICA, see the musica.mechanism_configuration

• MusicBox
  • acom_music_box.music_box module
    • MusicBox
      • MusicBox.add_evolving_condition()
      • MusicBox.loadJson()
      • MusicBox.load_mechanism()
      • MusicBox.solve()
  • acom_music_box.conditions module
    • Conditions
      • Conditions.from_config()
      • Conditions.read_data_values_from_table()
      • Conditions.read_initial_conditions_from_file()
      • Conditions.retrieve_initial_conditions_from_JSON()
  • acom_music_box.evolving_conditions module
    • EvolvingConditions
      • EvolvingConditions.add_condition()
      • EvolvingConditions.from_config()
      • EvolvingConditions.read_conditions_from_file()
  • acom_music_box.data_output module
    • DataOutput
      • DataOutput.output()
  • acom_music_box.plot_output module
    • PlotOutput
      • PlotOutput.plot()
  • acom_music_box.model_options module
    • BoxModelOptions
      • BoxModelOptions.from_config()
  • acom_music_box.utils module
    • calculate_air_density()
    • convert_concentration()
    • convert_from_number_density()
    • convert_pressure()
    • convert_temperature()
    • convert_time()
    • convert_to_number_density()
    • extract_unit()
    • get_available_units()