Installation

Requirements

SolarWindPy requires Python 3.11 or later and has the following core dependencies:

  • NumPy ≥ 1.22

  • Pandas ≥ 1.5

  • SciPy ≥ 1.10

  • Matplotlib ≥ 3.5

  • Astropy ≥ 5.0

Installation from PyPI

The recommended way to install SolarWindPy is from PyPI using pip:

pip install solarwindpy

This will install the latest stable release along with all required dependencies.

Installation from conda-forge

SolarWindPy is also available through conda-forge:

conda install -c conda-forge solarwindpy

Note

The conda-forge package for v0.1.5 is temporarily unavailable due to CI infrastructure issues (see issue #8). Install from PyPI to get the latest version. The conda-forge package will be updated once the issue is resolved.

Development Installation

To work with the latest development version, clone the repository and install in development mode:

git clone https://github.com/blalterman/SolarWindPy.git
cd SolarWindPy
pip install -e .

For contributors, install the additional development tools:

pip install -r requirements-dev.txt

Conda Environment Setup

For a complete scientific Python environment, use the provided conda environment file:

conda env create -f solarwindpy.yml
conda activate solarwindpy

Verification

To verify your installation, run:

import solarwindpy as swp
print(f"SolarWindPy version: {swp.__version__}")

Troubleshooting

If you encounter installation issues:

  1. Ensure you have Python 3.11 or later

  2. Update pip: pip install --upgrade pip

  3. Consider using a virtual environment

  4. Check the GitHub Issues for known problems