Installation Guide

Installation Instructions

This document provides detailed installation instructions including configuring a Python installation from scratch using conda. This guide is intended for users that are not familiar with configuring their own Python virtual environments.

For this example, we will be using conda a package management system that handles binary installations well.

If you prefer to not use conda you can follow the instructions on the README file in the repository. We recommend setting up a virtual environment for this installation.

Installing Python

Here are some instructions on how you can install conda. We recommend using miniconda, because this lightweight distribution does not ship with any extra packages or libraries.

1. Navigate to this webpage and download the appropriate installer for your operating system.

2. Install miniconda. Instructions are available here.

Installing pyCSEP

If the conda installation was successful, you should now be able to create a conda environment and install pyCSEP. The following instructions work for *nix systems with an interactive shell.

1. Create a conda environment and activate using

conda create -n pycsep
conda activate pycsep

2. Install pyCSEP using

conda install --channel conda-forge pycsep

Verifying installation

You can verify the installation by opening an interactive Python session on the command line.

python -c 'import csep'

If the installation works, that command will run without error.

(optional) Working with Jupyter Lab

For new python users, we recommend using Jupyter Lab to create your evaluations. It can be installed by

conda install --channel conda-forge jupyterlab
jupyter-lab

Jupyter-lab will open in a browser, and you can create/open your scripts from there.