This package contains a set of utilities to open and analyze OSIRIS output files, using Python. All the methods implemented are fully integrated with NumPy, and use np.ndarray as the main data structure. High-level functions are provided to manipulate data from OSIRIS, from reading the data of the diagnostics, to making post-processing calculations.
All code is written in Python. To contact the dev team, please send an email to João Biu: joaopedrofbiu@tecnico.ulisboa.pt. The full dev team can be found below in the Authors and Contributors section.
To install this package, you can use pip:
pip install osiris_utils
To install it from source, you can clone this repository and run (in the folder containing setup.py):
git clone https://github.com/joaopedrobiu6/osiris_utils.git pip install .
Finally, you can install it in editor mode if you want to contribute to the code:
git clone https://github.com/joaopedrobiu6/osiris_utils.git pip install -e .
The documentation is available at https://osiris-utils.readthedocs.io or via this link: osiris-utils.readthedocs.io.
- João Biu
- João Cândido
- Diogo Carvalho