Data

Tools

Indexes

Applications

Experiments

Open Source Science

magplots

A python library to pull data and make plots from ground magnetometers. Emphasis on plots for comparing magnetometers at conjugate points.

https://github.com/kcollins/magplots

Science Score: 67.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 5 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 (12.0%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

A python library to pull data and make plots from ground magnetometers. Emphasis on plots for comparing magnetometers at conjugate points.

Basic Info
  • Host: GitHub
  • Owner: KCollins
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 44.9 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 1
  • Open Issues: 23
  • Releases: 7
Created over 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

magplots

DOI PyPI version Documentation Status

A python library to pull data and make plots from ground magnetometers. Emphasis on plots for comparing magnetometers at geomagnetic conjugate points.

Installation

To install from pypi: pip install magplots

To install from source: Clone git repo and run python -m pip install . from top level of directory. Make sure that you have a folder in your directory named /output. This is where plots and dataframes will be saved.

MWE

You can check all the component functions by running the magall() function with default values. ``` from magplots.magFunctions import * # packaged version

from magFunctions import * # local version

magall(is_verbose = True) ```

Functions

Type help('magFunctions') for function documentation.

To pull data from Tromsø Geophysical Observatory, save a password locally in a file named tgopw.txt. (You will have to obtain the password from TGO.) If no such file exists, data is automatically pulled from CDAWeb.

Example Plots

Time domain plot:

This plot is produced with the magplot() function: timedomain

Spectrogram:

This plot is produced with the magspect() function: spectrogram

Wave Power Plot:

This plot is produced with the wavefig() function, which calls wavepwr() to calculate the wave power for each station within a given frequency range. By default the frequency range used is the Pc5 range, 1.667 to 6.667 mHz (150-600s). For a given timespan, the integrated wave power is plotted versus the latitude of the stations, with different colors for Arctic and Antarctic magnetometers, in order to illustrate hemispheric asymmetry. This approach is based on Figure 4 of Pilipenko 2021. waveplot

Owner

  • Login: KCollins
  • Kind: user

Citation (citation.CFF) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- affiliation: Space Science Institute
  family-names: Collins
  given-names: Kristina
  orcid: 0000-0002-3816-1948
title: "magplots: a Python library for conjugate ground magnetometers"
version: 1.0.0
doi: 10.5281/zenodo.10703227
license:
- mit
date-released: 2024-04-22
url: "https://github.com/KCollins/magplots"
repository-code: https://github.com/KCollins/magplots
type: software

GitHub Events

Total
  • Issues event: 6
  • Issue comment event: 3
  • Push event: 37
  • Pull request event: 1
Last Year
  • Issues event: 6
  • Issue comment event: 3
  • Push event: 37
  • Pull request event: 1

Packages

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

A python library for generating plots from conjugate magnetometers.

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 57 Last month
Rankings
Dependent packages count: 9.9%
Average: 37.6%
Dependent repos count: 65.3%
Maintainers (1)
kd8oxt
Last synced: 10 months ago

Dependencies

.github/workflows/python-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
requirements.txt pypi
  • ai.cdas *
  • datetime *
  • matplotlib *
  • numpy *
  • pandas *
  • plotly *