Skip to main content

Python package to implement an ions scheme in the D-region to model the dynamics of ions and electrons during solar flares. This is currently a private repository while I develop it, but will be made public later on when it's ready

Project description

Coverage Status pre-commit Code style: black

D-region ion scheme

This is the LIR-ACheM (Lower Ionosphere Region - Absorption & Chemistry Modelling) scheme.

This code works in three steps (more details are in the documentation):

  • The initialisation of the ionosphere
  • The modelling of the ionosphere from a varying forcing source
  • The computation of the HF absorption

This ion scheme is adapted from the six ions scheme from Mitra & Rowe, 1972.

Its main advantages compared to other more complex chemsistry schemes are:

  • It is much simpler
  • It has been created for D-region dynamics during solar flares
  • It is self-consistent, and all reaction rates are known since the actual species are specified (with the exception of cluster ions and light negative ions)

Please refer to the documentation for information on the scheme and the code used to implement it.

Testing

To test the entire package, you can run

pytest

This is the minimal version to check that all tests are passed. If, however, you're developping your own branch of the repository, or if you want the coverage report, run:

pytest --cov=lir_achem --cov-report=xml:reports/coverage/coverage.xml
coverage html
genbadge coverage -o reports/coverage/coverage-badge.svg

This will create a full coverage report and a badge to display the new coverage

NOTE: Don't do this if you don't need this. It does take a few minutes to run all the tests.

History

Written by P. Teysseyre and C. Briand (LIRA, Observatoire de Paris, Université PSL, Sorbonne Université, Université Paris Cité, CY Cergy Paris Université, CNRS, Meudon, France) in October 2025 - February 2026

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

lir_achem-1.2.3.tar.gz (34.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lir_achem-1.2.3-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

Details for the file lir_achem-1.2.3.tar.gz.

File metadata

  • Download URL: lir_achem-1.2.3.tar.gz
  • Upload date:
  • Size: 34.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for lir_achem-1.2.3.tar.gz
Algorithm Hash digest
SHA256 748e3a9208ede4c96adf7f8de792773fbcc92ce1aac29f2c839bab2d8d2428a9
MD5 e722529670b747f6eee6aa1ca302d3fb
BLAKE2b-256 900f17f7bb72431c461eac4fdcfb2e6c2c1cb38f521f5a8d8aff9222b42bea13

See more details on using hashes here.

File details

Details for the file lir_achem-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: lir_achem-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 35.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for lir_achem-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a6a880e76352917fb88b48f5a562d322eaed975ce2a7e36dbec96dded70d0a11
MD5 ef895084dc82e4d9d7a84fa399163d2e
BLAKE2b-256 49f9d17c1c2a721d5608a0f05156a61e87614107e8353d5ca484d506b23dcdf0

See more details on using hashes here.

Supported by

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