Data

Tools

Indexes

Applications

Experiments

Open Source Science

pysecs

An open source library for calculating Spherical Elementary Current Systems (SECS)

https://github.com/greglucas/pysecs

Science Score: 77.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
    Found 12 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

An open source library for calculating Spherical Elementary Current Systems (SECS)

Basic Info
  • Host: GitHub
  • Owner: greglucas
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 54.2 MB
Statistics
  • Stars: 9
  • Watchers: 1
  • Forks: 5
  • Open Issues: 4
  • Releases: 2
Created over 7 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

pysecs

DOI PyPi Downloads

pysecs is an open-source library for calculating Spherical Elementary Current Systems (SECS).

Features

  • Based upon the scikit-learn framework with fit() and predict() methods.
  • The only dependency is NumPy. It is built using fast broadcasting techniques to provide highly scalable calculations.

Examples

Examples can be found in examples/

Install

The easiest method to install pysecs is with pip.

```bash

pip install pysecs ```

For a source install you can follow these instructions:

  1. Clone the git repository

    ```bash

    git clone https://github.com/greglucas/pysecs ```

  2. Build and install the package

    ```bash

    pip install . ```

  3. Testing The package has a test suite that can be run with pytest

    ```python

    pytest ```

License

The code is released under an MIT license License described in LICENSE.md

References

This package has been developed from different publications. Please consider citing the papers that are relevant to the work you are doing if you are utilizing this code.

Software

bibtex Lucas, G., Rigler, E. J., Murphy, B. (2024). greglucas/pysecs: REL: v0.3.0 (v0.3.0). Zenodo. https://doi.org/10.5281/zenodo.14511596

Original Paper

bibtex Amm, O. "Ionospheric Elementary Current Systems in Spherical Coordinates and Their Application." Journal of geomagnestism and geoelectricity 49.7 (1997): 947-955. doi:10.5636/jgg.49.947

Applications Paper

bibtex Amm, O., and A. Viljanen. "Ionospheric disturbance magnetic field continuation from the ground to the ionosphere using spherical elementary current systems." Earth, Planets and Space 51.6 (1999): 431-440. doi:10.1186/BF03352247

Problems or Questions

Owner

  • Name: Greg Lucas
  • Login: greglucas
  • Kind: user
  • Location: Boulder, CO
  • Company: LASP / @lasp / @SWxTREC

I am an engineer and scientist. I primarily write numerical code in Python and Fortran.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: pysecs
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Greg
    family-names: Lucas
    email: greg.lucas@lasp.colorado.edu
    affiliation: >-
      University of Colorado Laboratory for      
      Atmospheric and Space Physics (LASP)
    orcid: 'https://orcid.org/0000-0003-1331-1863'
identifiers:
  - type: doi
    value: 10.5281/zenodo.14511595
    description: DOI for all versions of the software
license: MIT

GitHub Events

Total
  • Create event: 9
  • Release event: 1
  • Issues event: 1
  • Watch event: 4
  • Delete event: 10
  • Issue comment event: 4
  • Push event: 24
  • Pull request review comment event: 5
  • Pull request review event: 7
  • Pull request event: 15
Last Year
  • Create event: 9
  • Release event: 1
  • Issues event: 1
  • Watch event: 4
  • Delete event: 10
  • Issue comment event: 4
  • Push event: 24
  • Pull request review comment event: 5
  • Pull request review event: 7
  • Pull request event: 15

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 46
  • Total Committers: 4
  • Avg Commits per committer: 11.5
  • Development Distribution Score (DDS): 0.196
Past Year
  • Commits: 14
  • Committers: 2
  • Avg Commits per committer: 7.0
  • Development Distribution Score (DDS): 0.214
Top Committers
Name Email Commits
Greg Lucas g****s@g****m 37
E. Joshua Rigler e****r@u****v 5
pre-commit-ci[bot] 6****] 3
bmurphy-usgs 5****s 1
Committer Domains (Top 20 + Academic)
usgs.gov: 1

Packages

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

Spherical Elementary Current System (SECS) Calculations.

  • Documentation: https://pysecs.readthedocs.io/
  • License: Copyright (c) 2018 Greg Lucas Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.3.0
    published about 1 year ago
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 63 Last month
Rankings
Dependent packages count: 10.0%
Forks count: 14.2%
Stargazers count: 21.5%
Dependent repos count: 21.7%
Average: 22.3%
Downloads: 44.1%
Maintainers (1)
greglucas
Last synced: 7 months ago

Dependencies

.github/workflows/ci-tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
  • codecov/codecov-action v3 composite
.github/workflows/doc-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • ad-m/github-push-action master composite
.github/workflows/doc-tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
.github/workflows/release.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
docs/requirements.txt pypi
  • matplotlib *
  • numpy *
  • pydata-sphinx-theme *
  • sphinx *
  • sphinx_gallery *
pyproject.toml pypi
  • numpy >=1.23