neptoon 0.13.5

The neptoon package makes CRNS processing and research simple.

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, reproduceable workflows, and comprehensive documentation

Installation

Basic Installation

pip install neptoon

GUI Installation

pipx install "neptoon[gui]"

Recommended Installation (Isolated Environment)

# Create a new environment with Python 3.10
conda create -n neptoon python=3.10 ipykernel
conda activate neptoon
pip install neptoon

For more detailed installation instructions, see the installation documentation.

Quick Start

from neptoon.io.read import DataHubFromConfig
from neptoon.workflow.process_with_yaml import ProcessWithConfig
from neptoon.config import ConfigurationManager

# 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 examples with sample data are available in the neptoon_examples repository.

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

• Issues: Report bugs or request features through GitLab issues
• Contact: Email us at [e-mail]
• Contributing: See the contribution guidelines for details on how to contribute

Authors and Acknowledgments

Lead Developers:

• Daniel Power ([e-mail])
• Martin Schrön ([e-mail])

Additional Contributors:

• Fredo Erxleben
• Steffen Zacharias
• Rafael Rosolem

License

neptoon is licensed under the MIT License. See the LICENSE file for details.

Citation

If you use neptoon in your research, please cite:

Power, D., Erxleben, F., Zacharias, S., Rosolem, R., & Schrön, M. (2025). neptoon (v0.8.2). Helmholtz Zentrum für Umweltforschung. https://doi.org/10.5281/zenodo.15181751