Installation

Release version

irispy-lmsal is part of the wider ecosystem of scientific Python packages for solar physics and therefore a working installation is more about installing the scientific Python ecosystem.

To install the Minifoge Python distribution download the executable for your Operation System.

The reason we choose Miniconda over Anaconda, is mainly due to the size as Anaconda comes with a full install of packages you probably do not need and this way you have more direct control over what has been installed into your Python virtual environment.

Using Miniforge

To install, launch a system command prompt or the ‘Miniforge Prompt’ (under Windows).

Note

We strongly recommend using a conda virtual environment.

Now to install irispy-lmasl within the default conda virtual environment:

$ conda install irispy-lmsal

This will install irispy-lmsal.

Updating

You can update to the latest version by running:

$ conda update irispy-lmsal

Development version

This section outlines how to install the development version of irispy-lmsal.

Stable Dependencies Install

Create a conda environment

The first step is to create a conda environment (let’s call it irispy-dev) in which to install the development version of irispy-lmsal. This will allow you to keep your root environment clean of development packages. From the command line, type:

$ conda create -n irispy-dev pip

This creates the irispy-dev conda environment with just pip. Next, you must activate that environment, i.e., switch into it.

$ conda activate irispy-dev

Clone irispy-lmsal repository

Now we need to clone the irispy repository from GitHub into a directory called irispy-git. From the directory in which you want irispy-git to reside. If you want to develop irispy-lmsal, you will want to fork the repository on GitHub and use that URL in the clone step above.

$ git clone <personal fork URL> irispy-git
$ cd irispy-git
$ git remote add upstream git@github.com:LM-SAL/irispy-lmsal.git

Install irispy-lmsal

Finally, we can install the development version.

$ cd irispy-git
$ pip install -e ".[dev]"

You are now e ready to develop irispy-lmsal.

Notice we install no dependencies or use conda to install this. The reason for this is that it is simply easier to use pip to setup development packages.

At times you might need to get the updated changes, to do so:

$ git remote update -p

From here, you will need to decide if you need to merge changes or rebase changes when you need to contribute the changes back.