# Getting started¶

## Installation¶

PRISM can be easily installed by either cloning the repository and installing it manually:

$git clone https://github.com/1313e/PRISM$ cd PRISM
$pip install .  or by installing it directly from PyPI with: $ pip install prism


PRISM can now be imported as a package with import prism. For using PRISM in MPI, mpi4py >= 3.0.0 is required (not installed automatically).

The PRISM package comes with two ModelLink subclasses. These ModelLink subclasses can be used to experiment with PRISM to see how it works. Using PRISM and the tutorials has several examples explaining the different functionalities of the package.

## Running tests¶

If one wants to run pytests on PRISM, all requirements_dev are required. The easiest way to run the tests is by cloning the repository, installing all requirements and then running pytest on it:

$git clone https://github.com/1313e/PRISM$ cd PRISM
$pip install -r requirements_dev.txt$ pytest


If PRISM and all requirements_dev are already installed, one can run the tests by running pytest in the installation directory:

$cd <path_to_installation_directory>/prism$ pytest


When using Anaconda, the installation directory path is probably of the form <HOME>/anaconda3/envs/<environment_name>/lib/pythonX.X/site-packages.

## Example usage¶

See Minimal example or the tutorials for a documented explanation on this example.

# Imports
from prism import Pipeline

# Define model data and create ModelLink object
model_data = {3: [3.0, 0.1], 5: [5.0, 0.1], 7: [3.0, 0.1]}