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.0.tar.gz (33.2 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.0-py3-none-any.whl (34.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lir_achem-1.2.0.tar.gz
  • Upload date:
  • Size: 33.2 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.0.tar.gz
Algorithm Hash digest
SHA256 da41c2fb315e5fb279bd8a69de85dce797cc226c7bda4efbced84f46399af14b
MD5 8e58829b7b0543d2cb9e5f6e0c276db8
BLAKE2b-256 679d3d9a11533a1dd3ae3db77809e87f4837c68932286190bbe61251b9687aa1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lir_achem-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 34.4 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 414250ef937d121a6a54d9002a536b388a7573279ae0262935a0cd5f1735d944
MD5 3e54f66608852c9ca512b36945b41ea5
BLAKE2b-256 24d127396579336b269c3f00ed6fcf892c4539a846fa536d25e175176f55098a

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