Data

Tools

Indexes

Applications

Experiments

Open Source Science

auroralbndrytools

Tools for getting a continuous representation of auroral boundaries and the motion of the auroral boundary from a set of points

https://github.com/dartspacephysiker/auroralbndrytools

Science Score: 49.0%

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

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

Repository

Tools for getting a continuous representation of auroral boundaries and the motion of the auroral boundary from a set of points

Basic Info
  • Host: GitHub
  • Owner: Dartspacephysiker
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 39.1 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 2
Created about 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme License Citation

README.rst 

|DOI| 

Overview
========

Auroral boundary tools

A set of tools for for creating a continuous representation of auroral boundaries and the motion of the auroral boundary from a set of points, possibly for multiple different times. These are based on the "analytic boundary velocity" equations derived by SMH here: https://essopenarchive.org/doi/full/10.22541/essoar.169447428.84472457/v1


Installation
------------

Using pip ::

    pip install --editable "auroralbndrytools @ git+https://github.com/Dartspacephysiker/auroralbndrytools.git@main"


Dependencies:

- numpy
- pandas
- scipy (scipy.interpolate, scipy.signal, and scipy.misc)
- apexpy (magnetic coordinate conversion)


..
   Quick Start
   -----------
   .. code-block:: python

       >>> # initialize by supplying a set of external conditions:
       >>> from pyswipe import SWIPE
       >>> m = SWIPE(350, # Solar wind velocity in km/s 
		     -4, # IMF By (GSM) in nT
		     -3, # IMF Bz (GSM) in nT, 
		     20, # dipole tilt angle in degrees 
		     80) # F107_index
       >>> # make summary plot:
       >>> m.plot_potential()

   .. image:: docs/static/example_plot.png
       :alt: Ionospheric potential (color) and electric field (pins)
    

References
----------
Derivation of equations for boundary normal velocity by SMH in appendix here: https://essopenarchive.org/doi/full/10.22541/essoar.169447428.84472457/v1

Equations and auroralbndrytools also used by Gasparini et al (in preparation)


.. |DOI| image:: https://zenodo.org/badge/728155056.svg
        :target: https://zenodo.org/badge/latestdoi/728155056

Owner

  • Name: Spencer Hatch
  • Login: Dartspacephysiker
  • Kind: user
  • Location: Bergen
  • Company: Birkeland Centre for Space Science

GitHub Events

Total
Last Year

Dependencies

pyproject.toml pypi
  • apexpy >= 1.0
  • future >= 0.16
  • numpy >= 1.14
  • pandas >= 0.20
  • scipy >= 0.9
  • toolz >= 0.8