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
- 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 — 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 version you used. The version label below follows the package VERSION;
the badge above uses the concept DOI, which covers all versions. DOIs for older
archived releases are listed on the Zenodo record.
Power, D., Köhli, M., Schrön, M., Trinkle, L., Erxleben, F., Rosolem, R., & Zacharias, S. (2026). Neptoon (Version 0.78.3) [Software]. Zenodo. https://doi.org/10.5281/zenodo.22099457
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.78.3},
doi = {10.5281/zenodo.22099457},
url = {https://doi.org/10.5281/zenodo.22099457},
}
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file neptoon-0.78.3.tar.gz.
File metadata
- Download URL: neptoon-0.78.3.tar.gz
- Upload date:
- Size: 14.2 MB
- Tags: Source
- Uploaded using 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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
da38fb00e091d382c86f8cfd09aedad6f2e3964ad66b9d68dbe6bcd77f262af1
|
|
| MD5 |
12af37a4837c2bd00ab792c219747b40
|
|
| BLAKE2b-256 |
858771280044a4ff4b66beeac5a7e2b06233abc1f10a35f8aaed5e5c97e069ba
|
File details
Details for the file neptoon-0.78.3-py3-none-any.whl.
File metadata
- Download URL: neptoon-0.78.3-py3-none-any.whl
- Upload date:
- Size: 7.8 MB
- Tags: Python 3
- Uploaded using 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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
97eb508eba21df47f98f1fa837e1cd6c409db8b34f6a1d66e0bff2291041aaac
|
|
| MD5 |
abc3da5828d6a97328b28c720a78a5a8
|
|
| BLAKE2b-256 |
787e0d96b7ef9aa514f3067d6a3bd52752dab8db78b3b7cd6751128b325b5067
|
