Skip to main content

DGM-HRTM

Gaussian atmospheric dispersion model coupled with a simplified Human Respiratory Tract Model (HRTM) for radiological exposure assessment.


Description

This project implements:

  • A Gaussian plume dispersion model for atmospheric transport of radionuclides
  • Integration with meteorological data (Open-Meteo API)
  • A Human Respiratory Tract Model (HRTM) for inhalation dose estimation
  • Support for:
    • Worker and public exposure
    • Age-dependent dose coefficients (ICRP-based)
    • Particle properties (density, shape factor)
  • Optional Mapbox-based geospatial visualization

Installation

Clone the repository and install in editable mode:

pip install dgm-hrtm

Usage

Run the interactive CLI:

dgm-run

You will be prompted to enter:

  • Domain parameters
  • Source/emission parameters
  • Dispersion model settings
  • Radionuclide and dose parameters
  • HRTM parameters
  • Meteorological configuration

Outputs

The simulation generates:

  • 2D concentration maps
  • Dose maps (Sv)
  • HRTM deposition results
  • Figures and plots
  • parameters.txt with full configuration

All outputs are stored in a RESULTS/ directory.


Optional: Mapbox Visualization

This project includes optional support for Mapbox to display real-scale geographic backgrounds in the 2D plume plots.

To use this feature, you must provide your own Mapbox access token.

How to get a Mapbox token

  • Create an account at https://www.mapbox.com
  • Go to your account dashboard → Access Tokens
  • Click Create a token
  • Use a public token (starts with pk.)
  • Copy the generated token

How to configure it

You can provide your token in two ways:

Option 1 (recommended): Environment variable

Linux / macOS:

export MAPBOX_TOKEN="your_token_here"

Windows PowerShell:

$env:MAPBOX_TOKEN="your_token_here"

Option 2: Direct configuration

If your installation includes a configuration file or constant, replace:

MAPBOX_TOKEN = "YOUR_TOKEN_HERE"

with your token.

Enable Mapbox in the simulation

Make sure the Mapbox option is enabled in your configuration:

use_mapbox = True

Notes

  • The Mapbox feature is optional — the simulation works without it
  • Do not share your token publicly
  • If maps do not load, verify that:
    • The token is correct
    • Mapbox is enabled

Authors

  • Óscar Olmo Torrecillas
  • Jorge Berenguer Antequera
  • José Francisco Benavente Cuevas

Metadata

Release files for dgm-hrtm 0.1.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 dgm-hrtm 0.1.0
File Size Uploaded Provenance Actions
dgm_hrtm-0.1.0.tar.gz 125.2 kB Without provenance Details for dgm_hrtm-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for dgm-hrtm 0.1.0
File Interpreter ABI Platform Actions
dgm_hrtm-0.1.0-py3-none-any.whl Python 3 none any Details for dgm_hrtm-0.1.0-py3-none-any.whl

Total release size: 261.2 kB

Release files / dgm_hrtm-0.1.0.tar.gz

Download URL dgm_hrtm-0.1.0.tar.gz
Size 125.2 kB
Tags Source
SHA-256 checksum
How to use checksums
fffc3e06f21d6133585c695fdb911035e53dc5b3d24b964aa4918f15a70e4190
BLAKE2b-256 checksum
How to use checksums
dfafc99486e7186f3602f777a1bf35a60a12f8b640a7e452978462b9ae3dfd30
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.12

Release files / dgm_hrtm-0.1.0-py3-none-any.whl

Download URL dgm_hrtm-0.1.0-py3-none-any.whl
Size 136.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b14e59e6cdea6e1c7d9e8e67c988229f63cf49beb0d2b1129574666c9e028113
BLAKE2b-256 checksum
How to use checksums
7a5dce36cde0df2b33e9c138cf70a5522587841e611f9d873959575813441245
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.12

Security for dgm-hrtm 0.1.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

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