neptoon
neptoon is a Python package for processing Cosmic-Ray Neutron Sensor (CRNS) data to produce field-scale soil moisture estimates.
Key Features
- Modular Correction Pipeline: Apply multiple correction methods for pressure, incoming intensity, humidity, and biomass
- Quality Assessment: Built-in data quality checks integrated with SaQC
- Sensor Calibration: Tools for N0 calibration using soil sampling data
- External Data Integration: Automatic integration with NMDB.eu for incoming neutron corrections
- Roving CRNS: Process mobile surveys with track-aware QA/corrections, shared geospatial adapters, gridding, footprints, interpolation, maps, and terrain products
- Multiple Interfaces: Use via Python API, configuration files, or GUI
- Published Science: Implementations based on peer-reviewed methodologies
- Reproducibility: Built-in reporting, reproducible workflows, and comprehensive documentation
Installation
pip install neptoon
Isolated Environment with uv (recommended):
uv init --python 3.11
uv add neptoon
Isolated Environment with conda:
conda create -n neptoon python=3.11 ipykernel
conda activate neptoon
pip install neptoon
For more detailed instructions, see the installation documentation.
Quick Start
from neptoon.config import ConfigurationManager
from neptoon.workflow import ProcessWithConfig
# Load configurations
config = ConfigurationManager()
config.load_configuration(file_path="path/to/sensor_config.yaml")
config.load_configuration(file_path="path/to/processing_config.yaml")
# Process data
yaml_processor = ProcessWithConfig(configuration_object=config)
yaml_processor.run_full_process()
Ready-to-use configurations, sample data, scripts, and notebooks are indexed in examples/README.md.
Documentation
Comprehensive documentation is available at:
- www.neptoon.org - Main documentation
- User Guide - Detailed workflow description
- Examples - Practical examples and tutorials
Project Status
Neptoon is currently in active development. Version 1.0, focusing on stability and robustness, is expected soon. Future plans include:
- Roving CRNS processing capabilities
- Server/Docker versions for automated processing
Support and Contribution
- Contact: Email us at contact@neptoon.org
- Issues: Report bugs or request features through GitLab issues
- Contributing: See the contribution guidelines for details on how to contribute
Authors and Acknowledgments
Lead Developers:
- Daniel Power — ORCID · Email
- Martin Schrön — ORCID · Homepage · Email
- Louis Trinkle — ORCID · Email
- Markus Köhli — ORCID · Homepage · Email
Acknowledgments:
- Fredo Erxleben — ORCID
- Steffen Zacharias — ORCID
- Rafael Rosolem — ORCID · Homepage
- Miguel Rico-Ramirez — ORCID
- Till Francke — ORCID
- Daniel Rasche — ORCID
License
Neptoon is licensed under the MIT License. See the LICENSE file for details.
Citation
Cite the archived version you used. The exact-version citation below points to
the latest archived Zenodo release; the source-tree package VERSION may be
ahead while the next release is being prepared. The badge above uses the concept
DOI, which covers all versions.
Power, D., Köhli, M., Schrön, M., Trinkle, L., Erxleben, F., Rosolem, R., & Zacharias, S. (2026). Neptoon (Version 0.99.51) [Software]. Zenodo. https://doi.org/10.5281/zenodo.23063750
BibTex
@software{Neptoon,
author = {Power, Daniel and Köhli, Markus and Schrön, Markus and Trinkle, Louis and Erxleben, Fredo and Rosolem, Rafael and Zacharias, Steffen},
title = {Neptoon},
year = 2026,
publisher = {Zenodo},
version = {v0.99.51},
doi = {10.5281/zenodo.23063750},
url = {https://doi.org/10.5281/zenodo.23063750},
}
More Detailed Documentation
Scientific literature
The scientific methods implemented or discussed by Neptoon are linked to their primary and supporting references in the scientific literature documentation.
Conventions
These documents define the coding standards and architectural patterns used throughout the project. They serve as the single source of truth for both human contributors and AI assistants.
- Logging - Logger setup and log level conventions.
- Testing - Test organization, fixtures, markers, and CI pipeline.
- ColumnInfo - Column naming system and enum usage.
- Configuration - Pydantic config models and YAML loading.
- Hub Pattern - CRNSDataHub, DataFrames, and quality flags.
- Corrections - Factory/Builder pattern for the correction pipeline.
- Git Workflow - Branching, CI pipeline, and release process.
AI-Assisted Development
The repository includes durable guidance for coding agents and contributors:
AGENTS.md— universal entry point and toolchain rulesagent/code-overview.md— detailed find/edit/test mapagent/architecture.md— stable architecture summaryagent/conventions/— recurring implementation conventionsagent/decisions/— architecture and policy recordsagent/playbooks/convention-audit.md— project-specific guidance audit
Temporary plans, session memory, current priorities, contributor profiles, and agent
personas are local concerns and are intentionally not tracked. See
agent/README.md for the repository/local boundary.
3 maintainers
Metadata
3 maintainers
Release files for neptoon 0.99.51
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| neptoon-0.99.51.tar.gz | 15.5 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| neptoon-0.99.51-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 24.2 MB
Release files / neptoon-0.99.51.tar.gz
| Download URL | neptoon-0.99.51.tar.gz |
|---|---|
| Size | 15.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
556fbad7764181aa9926069c3fe9972dbdad0189934592e551381cc6b882e88d
|
|
BLAKE2b-256 checksum How to use checksums |
e83bcef24a5fd8da132d18303a52e4f84fb0196e20b76ac4df25d4f6942f51a2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / neptoon-0.99.51-py3-none-any.whl
| Download URL | neptoon-0.99.51-py3-none-any.whl |
|---|---|
| Size | 8.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d9e609a4729346c8e490e3bf0a84fcef09011460f72eff4f78b8e57ac3e34194
|
|
BLAKE2b-256 checksum How to use checksums |
e5f3cb564d2ef20bccf5cf1f2f9ac637f9548449d767d72b52a58e5497b1c317
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
