Getting Started

Requirements

Roxie-api uses the Poetry package manager<https://python-poetry.org/> for dependency resolution. The poetry package can be installed system wide via pip (pip3 install poetry), or on user level using their installation script.

curl -sSL https://install.python-poetry.org | python3 -

More details and information on how to use poetry can be found at the poetry Documentation site<https://python-poetry.org/docs/#installation>.

Roxie-api uses pyvista for 3D plots. Their package requires libGL, which can be installed with `dnf install libglvnd-glx (for CentOS, Alma Linux, Redhat, etc.) or apt-get install libgl1 for debian/Ubuntu.

Installation

The roxie-api package is hosted at [PyPi](https://pypi.org/project/roxie-api/), and accessible from there. It can be installed directly using pip:

pip install roxie-api

Using the package

The Example galery gives a list of examples using the package.

Source code and contribution

The project is currently hosted at CERN gitlab, which limits access to users holding a CERN account. Let us know if you want to contribute, and we can discuss how to best access the sources. We’re happy to share the python sources, and open for suggestions.