Metadata-Version: 2.4
Name: solarwindpy
Version: 0.1.4
Summary: Python package for solar wind data analysis.
Author-email: "B. L. Alterman" <blaltermanphd@gmail.com>
License: LICENSE
        =======
        
        BSD 3-Clause License
        
        Copyright (c) 2019, B. L. Alterman
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Bug Tracker, https://github.com/blalterman/SolarWindPy/issues
Project-URL: Source, https://github.com/blalterman/SolarWindPy
Keywords: plasma,physics,solar wind,measurements,in situ,spacecraft
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: <4,>=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: numpy<2.0,>=1.22
Requires-Dist: scipy>=1.10
Requires-Dist: pandas>=1.5
Requires-Dist: numexpr>=2.8
Requires-Dist: bottleneck>=1.3
Requires-Dist: h5py>=3.8
Requires-Dist: pyyaml>=6.0
Requires-Dist: matplotlib>=3.5
Requires-Dist: astropy>=5.0
Requires-Dist: numba>=0.57
Requires-Dist: tabulate>=0.9
Provides-Extra: dev
Requires-Dist: pytest>=7.4.4; extra == "dev"
Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: doc8; extra == "dev"
Requires-Dist: flake8-docstrings; extra == "dev"
Requires-Dist: pydocstyle; extra == "dev"
Requires-Dist: numpydoc; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx_rtd_theme; extra == "dev"
Requires-Dist: sphinxcontrib-spelling; extra == "dev"
Requires-Dist: sphinxcontrib-bibtex; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest>=7.4.4; extra == "test"
Requires-Dist: pytest-cov>=4.1.0; extra == "test"
Dynamic: license-file

###########
SolarWindPy
###########

|Build Status| |Docs Status| |License| |Black Code|

Python data analysis tools for solar wind measurements.

Quick Start
-----------

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

.. code-block:: python

   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 will soon be installable from pip via
``pip install solarwindpy``. We plant to target conda quickly there
after, most likely through the ``conda-forge`` channel.

User
----

Install from pip (when available):

.. code-block:: bash

   pip install solarwindpy  # Requires Python 3.10+

Development
-----------

1. Fork the repository and clone your fork.
2. Create a Conda environment using the provided YAML file (Python 3.10+):

   .. code-block:: bash

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

   Alternatively generate the environment from ``requirements-dev.txt``:

   .. code-block:: bash

      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``:

   .. code-block:: bash

      pytest -q

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

   .. code-block:: bash

      python scripts/update_conda_recipe.py

5. Optionally install the pre-commit hooks:

   .. code-block:: bash

      pre-commit install

   This will run ``black`` and ``flake8`` automatically when committing.

6. Build the documentation and fail on warnings:

   .. code-block:: bash

      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.

.. _LICENSE.rst: ./LICENSE.rst
.. _CITATION.rst: ./CITATION.rst

.. |Build Status| image:: https://github.com/blalterman/SolarWindPy/actions/workflows/ci-master.yml/badge.svg?branch=master
   :target: https://github.com/blalterman/SolarWindPy/actions/workflows/ci-master.yml
.. |Docs Status| image:: https://readthedocs.org/projects/solarwindpy/badge/?version=latest
   :target: https://solarwindpy.readthedocs.io/en/latest/?badge=latest
.. |License| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
   :target: ./LICENSE.rst
.. |Black Code| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
