Skip to main content

Overview

A tool for converting geomagnetic coordinates in DMSP data files to AACGM coordinates. The aacgmv2 Python library is leveraged for the conversion.

Supported Files

The tool currently supports conversions of the following data files:

Source File Type Contents Example
Cedar Madrigal Database HDF5 1-second resolution for Ion Drift, Magnetometer, and Electron Density dms_20150410_16s1.001.hdf5
Cedar Madrigal Database HDF5 Flux/Energy values dms_20150410_16e.001.hdf5

To add support for additional files, please reach out to offillcarson@gmail.com, or submit a pull request.

Installation

pip install dmsp-to-aacgm

Command-line Usage

dmsp-to-aacgm <input file/directory> [<output directory>] [--reduced]

If the output directory is not specified, or the output directory is the same as the input directory, the input files will be modified. Specifying the --reduced flag will output an h5 file containing only time and aacgm data.

Examples

Command Description
dmsp-to-aacgm dms_20150410_16s1.001.hdf5 Convert a single file
dmsp-to-aacgm dms_20150410_16s1.001.hdf5 aacgm_conversions Convert a single file, output to aacgm_conversions
dmsp-to-aacgm dmsp_data Convert all files in dmsp_data
dmsp-to-aacgm dmsp_data aacgm_conversions Convert all files in dmsp_data, output to aacgm_conversions
dmsp-to-aacgm dms_20150410_16s1.001.hdf5 aacgm_conversions --reduced Create an h5 file containing time and aacgm data only, output to aacgm_conversions

Usage in Python

from dmsp_to_aacgm import get_dataset

# Convert a file
data_set = get_dataset("dms_20150410_16s1.001.hdf5")
data_set.convert()
data_set.close()

# Create a converted file in "aacgm_conversions"
data_set = get_dataset("dms_20150410_16s1.001.hdf5")
data_set.convert(output_path="aacgm_conversions/dms_20150410_16s1.001.hdf5")
data_set.close()

# Create an h5 file containing only time and aacgm data in the "aacgm_conversions" directory
data_set = get_dataset("dms_20150410_16s1.001.hdf5")
data_set.convert(output_path="aacgm_conversions/aacgm_only_file.hdf5", minimal=True)
data_set.close()

Acknowledgements

The software was written by Carson O'Ffill and the project was guided by Simon Wing. We also acknowledge the following grants:

NASA Grants:

  • 80NSSC20K0704
  • 80NSSC22K0515
  • 80NSSC23K0899
  • 80NSSC23K0904

NSF CEDAR Grants:

  • 2431665

This software is distributed for free under an MIT license. If you find it useful, please acknowledge our work in your publications or projects.

Contact Info

Simon Wing: simon.wing@jhuapl.edu

Carson O'Ffill: offillcarson@gmail.com

Metadata

Release files for dmsp-to-aacgm 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dmsp-to-aacgm 1.3.0
File Size Uploaded
dmsp_to_aacgm-1.3.0.tar.gz 8.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for dmsp-to-aacgm 1.3.0
File Interpreter ABI Platform
dmsp_to_aacgm-1.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 18.8 kB

Release files / dmsp_to_aacgm-1.3.0.tar.gz

Download URL dmsp_to_aacgm-1.3.0.tar.gz
Size 8.9 kB
Tags Source
SHA-256 checksum
How to use checksums
2b9f2b93e15c799b15d91ab02fc459ae43f1907d84998da8805d00f76882fe2f
BLAKE2b-256 checksum
How to use checksums
1e1c90ef1187827f5bba224def75594919a1342dea15e0621724cfacaeea854c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jan 27, 2025.

Transparency log

Release files / dmsp_to_aacgm-1.3.0-py3-none-any.whl

Download URL dmsp_to_aacgm-1.3.0-py3-none-any.whl
Size 9.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0a09a02dfa4af33901f62bf59c209e614554bf6e7e437ed033afba68c4908bd4
BLAKE2b-256 checksum
How to use checksums
21cda808022e9500011bf3e8aa779a30eacdeb411d089d6c6d87f1d986897801
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jan 27, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

1.3.0 This release

2 release files

1.1.0

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page