Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 1.88 KB

README.md

File metadata and controls

62 lines (41 loc) · 1.88 KB

ronswanson

CI codecov Documentation Status DOI PyPI PyPI - Downloads

alt text

Ron Swanson builds tables for 3ML.

This tool provides an easy interface to construct 3ML table models from computational expensive simulations on HPC systems. Why? Because it is your right to do so!

Installation

pip install ronswanson

or

git clone https://github.com/grburgess/ronswanson
cd ronswanson
python setup.py install

Contributing

Contributions to ronswanson are always welcome. They can come in the form of:

Bug reports

Please use the Github issue tracking system for any bugs, for questions, and or feature requests.

Code

Additional features you have the impetus to add are always welcome. Please follow the PEP8 python standards and format your code with black

Documentation

Additions or examples, tutorials, or better explanations are always welcome. To ensure that the documentation builds with the current version of the software, I am using jupytext to write the documentation in Markdown. These are automatically converted to and executed as jupyter notebooks when changes are pushed to Github.

Credits

Inspiration by Elisa Schoesser.