Skip to main content

Python API for Fortran MSISE-00 neutral atmosphere model.

Project description

MSISE-00 in Python and Matlab

Zenodo DOI Language grade: Python Actions Status Build Status Python versions (PyPI) PyPi Download stats

NRL MSISE-00 atmospheric model for Python. Also accessible via Matlab. Valid from altitude z = 0..1000 km.

The plot immediately below shows a slice at 200km on a world-wide grid. The yellow ball represents the sun footprint on Earth.

MSIS global time animation

This plot is from Matlab calling MSISE00:

MSISE00 Matlab

Units

  • Temperature: degrees Kelvin [K]
  • Density: particles per cubic meter [m^-3]
  • Mass density: kilograms per cubic meter [kg m^-3]

Install

This process is used for the Python and Matlab access to MSIS. Any Fortran compiler should work. Fortran compiler may be installed by

  • MacOS / Homebrew: brew install gcc
  • Linux: apt install gfortran
  • Windows

Get MSISE00 and install Python package:

pip install msise00

or for the latest development code

git clone https://github.com/space-physics/msise00

pip install -e msise00

optionally check that MSIS is working via:

pytest msise00

This Python module uses our build-on-run technique. The first time you use this Python module, you will see messages from the Meson build system.

Examples

MSISE00 can be used from the command line, as an imported module, and even from Matlab.

import module

import msise00
from datetime import datetime

atmos = msise00.run(time=datetime(2013, 3, 31, 12), altkm=150., glat=65., glon=-148.)

atmos is an xarray.Dataset containing all the simulation output values. atmos is 4-D: (time, altitude, lat, lon), and indexed like atmos['N2']

Command Line

Write NetCDF4 output (HDF5 compatible) with command line argument -w filename.nc.

Simple examples under Examples/

  • Altitude Profile at a single time:

    msise00 -t 2017-08-21T20:48 -c 40 -90
    
  • Alt. profile time-range with hourly time step:

    msise00 -t 2017-08-21 2017-08-22 -c 40 -90
    
  • Grid: time,lat,lon: generates the plots in the README:

    msise00 -t 2016-09-20 2016-09-21
    
  • single time lat/lon can be plotted:

    msise00 -t 2017-01-02T12
    

Matlab

Matlab use of MSISE00 is demonstrated in Examples

MSISE00 will automatically compile "build on run" on first run from Matlab as with Python.

Optionally, verify Matlab is working by from the top msise00/ directory in Terminal

matlab -batch msise00.test_mod

Fortran

Those wishing to use MSIS from a plain Fortran program can do from the top-level msise00/ directory:

cmake -B build
cmake --build build

optionally:

ctest --test-dir build

Reference

  • Original fortran code
  • 1200+ citations 2002 paper

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

msise00-1.10.1.tar.gz (38.8 kB view details)

Uploaded Source

File details

Details for the file msise00-1.10.1.tar.gz.

File metadata

  • Download URL: msise00-1.10.1.tar.gz
  • Upload date:
  • Size: 38.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for msise00-1.10.1.tar.gz
Algorithm Hash digest
SHA256 6b4034c44915a162eb4c3dc719c5b8e1e942b688e22f3a35040f0b60fc6c48b2
MD5 cab7b5f8a74f18abac23609cb3462d45
BLAKE2b-256 2c9a1853ab07effbc34a0a1a3671062a0f44bd92046d5717273b7c0438feeaa6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page