Installing

Requirements

Python 3.10 or later is required to install and run this package.

If you do not have Python installed already, use these instructions to download and install it.

We recommend to install Miniconda or Anaconda, that come with a suite of packages useful for scientific data analysis and ease the installation process. These two provide Conda which is a an open-source package and environment management system that runs on Windows, macOS, and Linux.

Conda as a package manager helps you find and install packages. With Conda you can quickly install, run, and update packages and their dependencies and you can also easily create, save, load, and switch between environments on your computer. Following the instuctions bellow, you can use Conda to make a separate environment to run this package, while you can continue running your usual version of Python in your normal environment.

Create Virtual Environment

Tip

We recommend to create a virtual environment before installing this package.

If you use Miniconda or Anaconda you can install the package creating a virtual environment first with Conda and then installing the package using pip.

Creating, Activating, and Deactivating a Conda Environment:

We create a new Conda environment called “solo-sis-loader”, and then activate it following the steps bellow:

1. Open a terminal or command prompt.

2. Use the following command to create a new Conda environment named “solo-sis-loader” and install Python:

   conda create --name solo-sis-loader python=3.10
   

   You can replace “3.10” with the desired Python version.

3. Use the following command to activate the “solo-sis-loader” environment:

   conda activate solo-sis-loader
   

   After executing this command, your prompt should change to indicate that the “solo-sis-loader” environment is active.

You can now install solo-sis-loader and work within this isolated environment when using this software package.

To deactivate the “solo-sis-loader” Conda environment and return to the base environment use,

conda deactivate

The environment will be deactivated, and you will return to the base Conda environment.

Install with pip

# Create the virtual environment
conda create --name solo-sis-loader python=3.10

# Activate the environment
conda activate solo-sis-loader

# Install the required packages using pip
pip install solo-sis-loader

Warning

Currently install with conda install solo-sis-loader is not suppoted.