Utils

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.

How to install it?

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 .

Quick-start

pip install osiris_utils              # from PyPI
python -m pip install matplotlib      # plotting backend (optional)
git clone https://github.com/joaopedrobiu6/osiris_utils  # sample data
cd osiris_utils
python examples/quick_start.py examples/example_data/thermal.1d

Command-Line Interface

osiris_utils includes a command-line interface for common operations. After installation, the utils command becomes available:

utils --version                     # Check version
utils --help                        # Show available commands

Available Commands:

• utils info - Display metadata about OSIRIS files and simulations

• utils export - Convert data to CSV, JSON, or NumPy formats

• utils plot - Create quick visualizations

• utils validate - Check file integrity

Examples:

Show simulation information:

utils info path/to/input.deck
utils info path/to/file.h5 --brief

Export data to different formats:

utils export file.h5 --format csv --output data.csv
utils export diagnostic/dir --format npy --output data.npy

Generate quick plots:

utils plot file.h5 --save plot.png
utils plot file.h5 --save plot.png --title "Ez Field" --cmap viridis

Validate simulation data:

utils validate path/to/input.deck
utils validate path/to/input.deck --check-missing

For detailed help on any command:

utils <command> --help

Documentation

The documentation is available at https://osiris-utils.readthedocs.io or via this link: osiris-utils.readthedocs.io.

Author

• João Biu

Contributors

• Diogo Carvalho

• João Cândido

• Margarida Pereira