3. Downloading and Installation

3.1. Prerequisites

The Raysect package requires Python 3.9+, numpy and matplotlib. IPython is recommended for interactive use.

3.2. Installation

Raysect is available from the python package repository pypi. The easiest way to install Raysect is using pip:

python -m pip install raysect

If you prefer to install Raysect from source, the source files can be downloaded from pypi or from our development repository. Once you have the source files, locate the folder containing the pyproject.toml file and run:

python -m pip install .

This should start the Raysect compilation and installation process. All required dependencies are automatically installed.

If you would like to play with the bleeding-edge code or contribute to development, please see the Raysect development repository on github.

3.3. Testing

A selection of test scripts can be run using Python’s built-in unittest framework. These tests are included in the source code and can be executed by running the following command in the source directory:

python -m unittest -v

This will automatically discover and run all tests without errors or failures.

Many of the demos used throughout the Raysect documentation are distributed with the source code in the demos folder.