How biswajitsadhu/pydoseia works
Project type and purpose
• pyDOSEIA is an open-source scientific Python package for radiation dose assessment from atmospheric releases.
• It provides an interactive CLI input generator, reads YAML configuration files, pulls in tabular data (Excel/CSV) for dose conversion factors and meteorology, runs computational models (inhalation, ingestion, external, plume-shine), and writes results (CSV, pickled objects).
File structure
• Top-level scripts:
• main.py – entry point
• auto_input_generator.py / auto_input_v18.py – interactive input generation modules
• test_module.py – basic module‐level tests
• Modules implementing functionality:
• auto_input_generator_funcs_class.py
• dosefunc.py, metfunc.py, raddcffunc.py, outputfunc.py, static_utils.py
• Configuration and input:
• configs/*.yaml – example scenario definitions
• data_sources.md – documentation of data sources
• Data libraries:
• library/half_life, ingestion_public, inhalation_HC2 – Excel/CSV dose conversion factor tables
• met_data/Met_data_5Yr.xlsx – historical meteorological data
• Environment and dependencies:
• environment.yml – conda environment spec
• Tests:
• test/ – YAML test cases + test/test_module.py
Extract insights from README
• Provides two high-level flowcharts (simple and INGEN)
• Describes the two major workflows:
a) Interactive Input Generator CLI (auto_input_generator.py)
b) Batch computation engine (main.py reading existing config)
• Highlights parallel processing via joblib, pickle outputs, CSV summaries.
Elements
• Clear labels:
[CLI Input Generator], [Config Loader], [Dose Conversion Loader], [Met Processing], [Dose Engine], [Output Writer], [Data Library], [Met Data], [YAML Configs], [Tests]
• CLI → Config Loader → Core Engine
• Core Engine ↔ Data Library / Met Data
• Core Engine → Output Writer
• Tests → each component
• Rectangles for code modules
• Parallelogram for CLI