Skip to main content

Coverage Status pre-commit Code style: black

Important

This model is available for academic purposes only. If you require any assistance, please contact us directly.

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 and numerically efficient
  • It has been created for D-region dynamics during solar flares
  • 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.

Installation

To install the package, just type:

pip install lir_achem

Please refer to the documentation for examples on how to start using the package.

Documentation

The full documentation is found here.

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

The associated paper is accepted for publication (Teysseyre & Briand, 2026, Atmospheres)

Metadata

Release files for lir-achem 1.3.1.post1

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

Source distribution (sdist)

Source distribution for lir-achem 1.3.1.post1
File Size Uploaded
lir_achem-1.3.1.post1.tar.gz 35.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lir-achem 1.3.1.post1
File Interpreter ABI Platform
lir_achem-1.3.1.post1-py3-none-any.whl Python 3 none any Details

Total release size: 71.2 kB

Release files / lir_achem-1.3.1.post1.tar.gz

Download URL lir_achem-1.3.1.post1.tar.gz
Size 35.0 kB
Tags Source
SHA-256 checksum
How to use checksums
5c4287ba1b3c593e8aeebe1e0df5f1e883add866e9d65efa554c83b00ffb9524
BLAKE2b-256 checksum
How to use checksums
58e2e8c62c09a560a9419bf8e49dea58e3be5e1e6ea77818801f6079e82301b0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.0

Release files / lir_achem-1.3.1.post1-py3-none-any.whl

Download URL lir_achem-1.3.1.post1-py3-none-any.whl
Size 36.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6002ecfb9441ea82bf9b0cfa0753a2368878d6e7c251b4f042edf04d9ee736ab
BLAKE2b-256 checksum
How to use checksums
0c3d85902f041335f9c2219f3283d75217f5842f026035e50660f15868a0f486
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.0

Release history Release notifications | RSS feed

This release

1.3.1.post1 This release

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

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