hsp2 0.11.0a1

1. Install the Anaconda Python Distribution

Install the latest release of the Anaconda Distribution, which includes the conda package manager, a complete Python (and R) data science stack, and the Anaconda Navigator GUI. Follow Anaconda Installation documentation.

A lighter-weight alternative is to install Miniconda.

2. Create a Conda Environment for HSP2 Modeling (optional)

Although HSP2 can be run from the default base environment created by Anaconda, we recommend creating a custom environment that includes the exact combination of software dependencies that we’ve in development and testing.

Use the following conda create command in your terminal or console:

conda create -c conda-forge -n hsp2_310 python=3.10

Install the necessary and optional packages for HSP2 in the new environment:

conda install -c conda-forge -n hsp2_310 cltoolbox numba pandas pytables
conda install -c conda-forge -n hsp2_310 h5py jupyterlab matplotlib notebook

conda activate hsp2_310

cd /path/to/module/hsp2
pip install .  # or "pip install -e ." to install in editable mode

You should now be able to run the Tutorials and create your own Jupyter Notebooks!

1. Install Python

Instructions for downloading Python to your computer based on your operating system can be found in this helpful wiki.

2. Create a Python Environment for HSP2 Modeling (optional)

Create a custom Python virtual environment for using HSP2, following the venv — Creation of virtual environments package documentation to create and activate a new environment for running HSP2.

python -m venv hsp2_env /path/to/python/virtual/environments/hsp2_env

3. PIP install HSP2

Navigate to your copy of the HSPsquared folder (for these instructions /path/to/module/hsp2) on your computer in the command line.

To install using pip:

source /path/to/python/virtual/environments/hsp2_env/bin/activate
cd /path/to/module/hsp2
pip install .  # or "pip install -e ." to install in editable mode

4. Run PIP Installed HSP2 from the Command Line

The pip installed ‘hsp2’ command has help created from the function docstrings in HSP2tools/HSP2_CLI.py.