Python wrapper

[mattldawson]

Investigate next steps for Python wrapper

Acceptance Criteria

• Issues created to address anything that would prevent using music-box python wrapper in a tutorial

Ideas

• Update Documentation #158
  • Update documentation
  • Add any missing documentation
  • Matching documentation style to MICM/TUV-x/MUSICA
• Address back-end specific items for MusicBox #159
  • Delegate the configuration conversion job (web version -> camp version) to the API sever.
  • Address things that are specific to acting as the back-end for online MusicBox.
  • Possibly move back-end specific things to a separate python module
• Ensure test coverage for MusicBox #160
  • Fix the test failure: test_chapman.py, test_full_gas_phase_mechanism.py
  • Add testing for any parts of the python wrapper that don't yet have tests
• Validate all configuration in MusicBox curriculum examples #161
  • Check all the configurations are valid
• Ensure run for all the examples in MusicBox #162
• Set up auto-deployment of documentation to GH pages #163
• Add code-formatting actions #164
  • Use autopep8
• Add command-line option for running python music-box #165
  • The command line arguments include one configuration file, the music box configuration, along with the mechanism configuration.
• Make sure evolving conditions are working properly #166
  • example evolving conditions.csv
  • Model time step starts at 0, goes forward 10 seconds at a time, and goes until 1000 seconds. It's possible to set evolving conditions that don't fall on a time step that would be run. Make sure to handle those conditions. (for example, setting temperature at 7 seconds, 19 seconds)
• Modify to work with lists or numpy arrays #167
  • The input to solve currently accepts a python list. Enforce all model data runs on numpy arrays to make sure there isn't any issue with precision when going from python to C++.
• Improve usability
  • Simplify music-box when possible in favor of having users implement custom features

[boulderdaze]

I created individual issues corresponding to each task except for the last one. I think we'd need discussion within team to decide which could improve usability and what design change should be made