Data

Tools

Indexes

Applications

Experiments

Open Source Science

solarwindpy

python data analysis tools for solar wind measurements

https://github.com/blalterman/solarwindpy

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

python data analysis tools for solar wind measurements

Basic Info
  • Host: GitHub
  • Owner: blalterman
  • License: other
  • Language: Python
  • Default Branch: master
  • Size: 12.2 MB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 3
  • Open Issues: 6
  • Releases: 10
Created about 7 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.rst 

###########
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

Owner

  • Name: blalterman
  • Login: blalterman
  • Kind: user
  • Location: Greenbelt, MD
  • Company: NASA Goddard Space Flight Center

Citation (CITATION.rst) 

CITATION
========

TODO

GitHub Events

Total
  • Create event: 146
  • Commit comment event: 1
  • Release event: 9
  • Issues event: 108
  • Watch event: 2
  • Delete event: 64
  • Issue comment event: 138
  • Push event: 360
  • Pull request event: 267
  • Fork event: 1
Last Year
  • Create event: 146
  • Commit comment event: 1
  • Release event: 9
  • Issues event: 108
  • Watch event: 2
  • Delete event: 64
  • Issue comment event: 138
  • Push event: 360
  • Pull request event: 267
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 89
  • Total pull requests: 254
  • Average time to close issues: 11 months
  • Average time to close pull requests: 17 days
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.76
  • Average comments per pull request: 0.37
  • Merged pull requests: 147
  • Bot issues: 0
  • Bot pull requests: 31
Past Year
  • Issues: 82
  • Pull requests: 251
  • Average time to close issues: about 6 hours
  • Average time to close pull requests: 1 day
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.83
  • Average comments per pull request: 0.36
  • Merged pull requests: 147
  • Bot issues: 0
  • Bot pull requests: 28
View more stats
Top Authors
Issue Authors
  • blalterman (89)
Pull Request Authors
  • blalterman (223)
  • dependabot[bot] (23)
  • github-actions[bot] (8)
Top Labels
Issue Labels
status:planning (50) plan:phase (36) sweep (19) Docs (17) plan:overview (13) enhancement (10) domain:docs (8) priority:low (8) Validation (6) python (5) priority:high (4) status:completed (4) goals (3) objectives (3) config (3) domain:infrastructure (3) CD (3) CI (3) domain:testing (2) priority:medium (2) plan:closeout (2)
Pull Request Labels
codex (190) dependencies (31) python (9) automated (8)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 235 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 5
  • Total maintainers: 1
pypi.org: solarwindpy

Python package for solar wind data analysis.

  • Documentation: https://solarwindpy.readthedocs.io/
  • 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.
  • Latest release: 0.1.4
    published 6 months ago
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 235 Last month
Rankings
Dependent packages count: 10.1%
Dependent repos count: 21.6%
Average: 40.4%
Downloads: 89.5%
Maintainers (1)
blalterman
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • Babel ==2.9.1
  • Bottleneck ==1.3.2
  • Jinja2 ==3.0.1
  • MarkupSafe ==2.0.1
  • Pillow ==8.2.0
  • PySocks ==1.7.1
  • PyYAML ==5.4.1
  • Pygments ==2.9.0
  • Sphinx ==4.0.2
  • alabaster ==0.7.12
  • appdirs ==1.4.4
  • astropy ==4.2.1
  • black ==21.5b2
  • bleach ==3.3.0
  • brotlipy ==0.7.0
  • cached-property ==1.5.2
  • certifi ==2021.5.30
  • cffi ==1.14.5
  • cfgv ==3.3.0
  • chardet ==4.0.0
  • click ==8.0.1
  • cmarkgfm ==0.5.3
  • colorama ==0.4.4
  • cryptography ==3.4.7
  • cycler ==0.10.0
  • distlib ==0.3.2
  • docutils ==0.15.2
  • editdistance-s ==1.0.0
  • filelock ==3.0.12
  • flake8 ==3.9.2
  • h5py ==3.2.1
  • identify ==2.2.10
  • idna ==2.10
  • imagesize ==1.2.0
  • importlib-metadata ==4.5.0
  • keyring ==23.0.1
  • kiwisolver ==1.3.1
  • llvmlite ==0.36.0
  • matplotlib ==3.4.2
  • mccabe ==0.6.1
  • mock ==4.0.3
  • mypy-extensions ==0.4.3
  • nodeenv ==1.6.0
  • numba ==0.53.1
  • numexpr ==2.7.3
  • numpy ==1.20.3
  • olefile ==0.46
  • packaging ==20.9
  • pandas ==1.2.4
  • pathspec ==0.8.1
  • pip ==21.1.2
  • pkginfo ==1.7.0
  • pre-commit ==2.13.0
  • pyOpenSSL ==20.0.1
  • pycodestyle ==2.7.0
  • pycparser ==2.20
  • pyerfa ==2.0.0
  • pyflakes ==2.3.1
  • pyparsing ==2.4.7
  • python-dateutil ==2.8.1
  • pytz ==2021.1
  • readme-renderer ==27.0
  • regex ==2021.4.4
  • requests ==2.25.1
  • requests-toolbelt ==0.9.1
  • rfc3986 ==1.5.0
  • scipy ==1.6.3
  • setuptools ==49.6.0.post20210108
  • six ==1.16.0
  • snowballstemmer ==2.1.0
  • sphinx-rtd-theme ==0.5.2
  • sphinxcontrib-applehelp ==1.0.2
  • sphinxcontrib-devhelp ==1.0.2
  • sphinxcontrib-htmlhelp ==2.0.0
  • sphinxcontrib-jsmath ==1.0.1
  • sphinxcontrib-qthelp ==1.0.3
  • sphinxcontrib-serializinghtml ==1.1.5
  • tables ==3.6.1
  • tabulate ==0.8.9
  • toml ==0.10.2
  • tornado ==6.1
  • tqdm ==4.61.0
  • twine ==3.4.1
  • typed-ast ==1.4.3
  • typing-extensions ==3.10.0.0
  • urllib3 ==1.26.5
  • virtualenv ==20.4.7
  • webencodings ==0.5.1
  • wheel ==0.36.2
  • zipp ==3.4.1
pyproject.toml pypi
setup.py pypi
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
  • pypa/gh-action-pypi-publish v1 composite
.github/workflows/update-workflow-doc.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
requirements-dev.txt pypi
  • astropy * development
  • black * development
  • bottleneck * development
  • flake8 * development
  • h5py * development
  • matplotlib * development
  • numba * development
  • numexpr * development
  • numpy * development
  • pandas * development
  • pytables * development
  • pytest * development
  • pyyaml * development
  • scipy * development
  • tabulate * development
.github/workflows/branch-protection.yml actions
  • actions/checkout v3 composite
  • benjefferies/branch-protection-bot master composite
.github/workflows/claude-code-review.yml actions
  • actions/checkout v4 composite
  • anthropics/claude-code-action beta composite
.github/workflows/claude.yml actions
  • actions/checkout v4 composite
  • anthropics/claude-code-action beta composite
.github/workflows/continuous-integration.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/docs.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/doctest_validation.yml actions
  • actions/cache v3 composite
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/github-script v6 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v4 composite
  • conda-incubator/setup-miniconda v3 composite
.github/workflows/release-management.yml actions
  • actions/checkout v3 composite
.github/workflows/release-pipeline.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
  • softprops/action-gh-release v1 composite
.github/workflows/security.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
.github/workflows/semver-check.yml actions
  • actions/checkout v4 composite
.github/workflows/sync-requirements.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
  • peter-evans/create-pull-request v5 composite
.github/workflows/test-fix.yml actions
docs/requirements.txt pypi
  • astropy >=5.0.0
  • doc8 *
  • matplotlib >=3.5.0
  • numpy >=1.20.0
  • numpydoc >=1.5.0
  • pandas >=1.3.0
  • scipy >=1.7.0
  • sphinx >=6.0,<8.0
  • sphinx_rtd_theme >=1.0.0
  • sphinxcontrib-bibtex >=2.5.0
  • sphinxcontrib-spelling *