solarwindpy 0.1.5

Python package for solar wind data analysis.

Python data analysis tools for solar wind measurements.

Quick Start

After installation, import the package and create a plasma object:

import solarwindpy as swp
# Load plasma data (example with sample data)
plasma = swp.Plasma()
# Access ion species and magnetic field data
print(plasma.data.columns)  # View available measurements

See the documentation for detailed usage examples and API reference.

Installation

SolarWindPy requires Python 3.10 or later.

SolarWindPy is available via PyPI and conda-forge:

User

Install from PyPI:

pip install solarwindpy  # Requires Python 3.10+

Or install from conda-forge:

conda install -c conda-forge solarwindpy

Development

1. Fork the repository and clone your fork.

2. Create a Conda environment using the provided YAML file (Python 3.10+):

   conda env create -f solarwindpy.yml  # Python 3.10+
   conda activate solarwindpy
   pip install -e .

   Alternatively generate the environment from requirements-dev.txt:

   python scripts/requirements_to_conda_env.py --name solarwindpy
   conda env create -f solarwindpy.yml
   conda activate solarwindpy
   pip install -e .

3. Run the test suite with pytest:

   pytest -q

4. Regenerate the Conda recipe if the version or dependencies change:

   python scripts/update_conda_recipe.py

5. Optionally install the pre-commit hooks:

   pre-commit install

   This will run black and flake8 automatically when committing.

6. Build the documentation and fail on warnings:

   cd docs
   make html SPHINXOPTS=-W

License

SolarWindPy is licensed under a standard 3-clause BSD license. See LICENSE.rst.

Acknowledging and Citing SolarWindPy

See CITATION.rst for instructions on citing SolarWindPy.