| Name | solarwindpy JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | Python package for solar wind data analysis. |
| upload_time | 2025-09-03 06:16:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4,>=3.10 |
| 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.
|
| keywords |
plasma
physics
solar wind
measurements
in situ
spacecraft
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
Bottleneck
PyYAML
Sphinx
astropy
black
doc8
flake8-docstrings
flake8
h5py
matplotlib
numba
numexpr
numpy
numpydoc
pandas
pydocstyle
pytest-cov
pytest
scipy
sphinxcontrib-bibtex
sphinxcontrib-spelling
tables
tabulate
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
###########
SolarWindPy
###########
|Build Status| |Docs Status| |License| |Black Code|
Python data analysis tools for solar wind measurements.
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-20250403.yml # Python 3.10+
conda activate solarwindpy-20250403
pip install -e .
Alternatively generate the environment from ``requirements-dev.txt``:
.. code-block:: bash
python scripts/requirements_to_conda_env.py --name solarwindpy-dev
conda env create -f solarwindpy-dev.yml
conda activate solarwindpy-dev
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/continuous-integration.yml/badge.svg?branch=master
:target: https://github.com/blalterman/SolarWindPy/actions/workflows/continuous-integration.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
Raw data
{
"_id": null,
"home_page": null,
"name": "solarwindpy",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.10",
"maintainer_email": null,
"keywords": "plasma, physics, solar wind, measurements, in situ, spacecraft",
"author": null,
"author_email": "\"B. L. Alterman\" <blaltermanphd@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/47/84/63db46bdf7f1ee88904eac148651384eedbe430409a4bf31ccd6d1a5be81/solarwindpy-0.1.2.tar.gz",
"platform": null,
"description": "###########\nSolarWindPy\n###########\n\n|Build Status| |Docs Status| |License| |Black Code|\n\nPython data analysis tools for solar wind measurements.\n\nInstallation\n============\n\nSolarWindPy requires Python 3.10 or later.\n\nSolarWindPy will soon be installable from pip via\n``pip install solarwindpy``. We plant to target conda quickly there\nafter, most likely through the ``conda-forge`` channel.\n\nUser\n----\n\nInstall from pip (when available):\n\n.. code-block:: bash\n\n pip install solarwindpy # Requires Python 3.10+\n\nDevelopment\n-----------\n\n1. Fork the repository and clone your fork.\n2. Create a Conda environment using the provided YAML file (Python 3.10+):\n\n .. code-block:: bash\n\n conda env create -f solarwindpy-20250403.yml # Python 3.10+\n conda activate solarwindpy-20250403\n pip install -e .\n\n Alternatively generate the environment from ``requirements-dev.txt``:\n\n .. code-block:: bash\n\n python scripts/requirements_to_conda_env.py --name solarwindpy-dev\n conda env create -f solarwindpy-dev.yml\n conda activate solarwindpy-dev\n pip install -e .\n\n3. Run the test suite with ``pytest``:\n\n .. code-block:: bash\n\n pytest -q\n\n4. Regenerate the Conda recipe if the version or dependencies change:\n\n .. code-block:: bash\n\n python scripts/update_conda_recipe.py\n\n5. Optionally install the pre-commit hooks:\n\n .. code-block:: bash\n\n pre-commit install\n\n This will run ``black`` and ``flake8`` automatically when committing.\n\n6. Build the documentation and fail on warnings:\n\n .. code-block:: bash\n\n cd docs\n make html SPHINXOPTS=-W\n\n\nLicense\n=======\n\nSolarWindPy is licensed under a standard 3-clause BSD license. See\n`LICENSE.rst`_.\n\nAcknowledging and Citing SolarWindPy\n====================================\n\nSee `CITATION.rst`_ for instructions on citing SolarWindPy.\n\n.. _LICENSE.rst: ./LICENSE.rst\n.. _CITATION.rst: ./CITATION.rst\n\n.. |Build Status| image:: https://github.com/blalterman/SolarWindPy/actions/workflows/continuous-integration.yml/badge.svg?branch=master\n :target: https://github.com/blalterman/SolarWindPy/actions/workflows/continuous-integration.yml\n.. |Docs Status| image:: https://readthedocs.org/projects/solarwindpy/badge/?version=latest\n :target: https://solarwindpy.readthedocs.io/en/latest/?badge=latest\n.. |License| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg\n :target: ./LICENSE.rst\n.. |Black Code| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n",
"bugtrack_url": null,
"license": "LICENSE\n =======\n \n BSD 3-Clause License\n \n Copyright (c) 2019, B. L. Alterman\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n * Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n * Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n * Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n ",
"summary": "Python package for solar wind data analysis.",
"version": "0.1.2",
"project_urls": {
"Bug Tracker": "https://github.com/blalterman/SolarWindPy/issues",
"Source": "https://github.com/blalterman/SolarWindPy"
},
"split_keywords": [
"plasma",
" physics",
" solar wind",
" measurements",
" in situ",
" spacecraft"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "837a994344362d9d8060c56203ff102f7a4d04f8935b57731a68d84e5d6901b4",
"md5": "f29123cff656bb2a141ec2524ab84ce6",
"sha256": "a9ffdc052276d0f103c97c5530e43d3c83fb97fe6e21e4d7b5519fecf7d46c51"
},
"downloads": -1,
"filename": "solarwindpy-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f29123cff656bb2a141ec2524ab84ce6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.10",
"size": 1303262,
"upload_time": "2025-09-03T06:16:03",
"upload_time_iso_8601": "2025-09-03T06:16:03.672167Z",
"url": "https://files.pythonhosted.org/packages/83/7a/994344362d9d8060c56203ff102f7a4d04f8935b57731a68d84e5d6901b4/solarwindpy-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "478463db46bdf7f1ee88904eac148651384eedbe430409a4bf31ccd6d1a5be81",
"md5": "78b2d1aacd17a250845174d2f171c447",
"sha256": "922e0cb2d6ac1840cc34512d992140addbe36891baa285bec9994220df7c3dd5"
},
"downloads": -1,
"filename": "solarwindpy-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "78b2d1aacd17a250845174d2f171c447",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.10",
"size": 1509830,
"upload_time": "2025-09-03T06:16:05",
"upload_time_iso_8601": "2025-09-03T06:16:05.363538Z",
"url": "https://files.pythonhosted.org/packages/47/84/63db46bdf7f1ee88904eac148651384eedbe430409a4bf31ccd6d1a5be81/solarwindpy-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-03 06:16:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "blalterman",
"github_project": "SolarWindPy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Bottleneck",
"specs": [
[
"==",
"1.5.0"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"==",
"6.0.2"
]
]
},
{
"name": "Sphinx",
"specs": [
[
"==",
"8.2.3"
]
]
},
{
"name": "astropy",
"specs": [
[
"==",
"7.1.0"
]
]
},
{
"name": "black",
"specs": [
[
"==",
"25.1.0"
]
]
},
{
"name": "doc8",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "flake8-docstrings",
"specs": [
[
"==",
"1.7.0"
]
]
},
{
"name": "flake8",
"specs": [
[
"==",
"7.3.0"
]
]
},
{
"name": "h5py",
"specs": [
[
"==",
"3.14.0"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"==",
"3.10.5"
]
]
},
{
"name": "numba",
"specs": [
[
"==",
"0.61.2"
]
]
},
{
"name": "numexpr",
"specs": [
[
"==",
"2.11.0"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"2.2.6"
]
]
},
{
"name": "numpydoc",
"specs": [
[
"==",
"1.9.0"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.3.1"
]
]
},
{
"name": "pydocstyle",
"specs": [
[
"==",
"6.3.0"
]
]
},
{
"name": "pytest-cov",
"specs": [
[
"==",
"6.2.1"
]
]
},
{
"name": "pytest",
"specs": [
[
"==",
"8.4.1"
]
]
},
{
"name": "scipy",
"specs": [
[
"==",
"1.16.1"
]
]
},
{
"name": "sphinxcontrib-bibtex",
"specs": [
[
"==",
"2.6.5"
]
]
},
{
"name": "sphinxcontrib-spelling",
"specs": [
[
"==",
"8.0.1"
]
]
},
{
"name": "tables",
"specs": [
[
"==",
"3.10.2"
]
]
},
{
"name": "tabulate",
"specs": [
[
"==",
"0.9.0"
]
]
}
],
"tox": true,
"lcname": "solarwindpy"
}
