PySi is a package and command line tool designed to make using the Monte Carlo radiative transfer and ionization code SIROCCO a wee bit easier to use.
The main purpose of PySi is to provide tools which allow you to easily plot and analyse the output from a SIROCCO simulation for both the synthetic spectra and the properties of the wind. PySi also includes a number of commands for setting up and running a grid of models, as well as tools to help determine the quality, convergence and trustworthiness of a model.
PySi requires Python 3.10, although it may work on earlier versions with a bit of work (possibly down to 3.7). You can install PySi either by modifying your $PYTHONPATH variable, or by using Pip.
shell$ pip install .The main interface for PySi will be the pysi command. This is
documented on ReadTheDocs. Another
valid use-case would be to import PySi (the actual Python package) into
your own scripts and use the classes and functions in your own scripts.
If you want to develop or modify parts of PySi, then you can either install
it in editable mode (pip install -e .) or I strongly recommend using
Poetry for handling dependency management and
tool installation.
shell$ poetry installDocumentation is hosted on
ReadTheDocs and stored in the
docs directory. The documentation is built using Sphinx and is still in
development.
To build the documentation locally, use the following command,
shell$ poetry run sphinx-build -a -j auto -b html docs/source/ docs/build/htmlThis will create a directory docs/build/html and you can view the
documentation by opening docs/build/html/index.html in your web browser.