# neptoon
[](https://pypi.org/project/neptoon/)
[](https://pypi.org/project/neptoon/)
[](https://www.neptoon.org)
[](https://codebase.helmholtz.cloud/cosmos/neptoon/-/blob/main/LICENSE)
[](https://pepy.tech/projects/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](https://rdm-software.pages.ufz.de/saqc/index.html)
- **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
```bash
pip install neptoon
```
### GUI Installation
```bash
pipx install "neptoon[gui]"
```
### Recommended Installation (Isolated Environment)
```bash
# 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](https://www.neptoon.org/en/latest/user-guide/installation/).
## Quick Start
```python
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](https://codebase.helmholtz.cloud/cosmos/neptoon_examples).
## Documentation
Comprehensive documentation is available at:
- [www.neptoon.org](https://www.neptoon.org) - Main documentation
- [User Guide](https://www.neptoon.org/en/latest/user-guide/workflow-description/) - Detailed workflow description
- [Examples](https://www.neptoon.org/en/latest/user-guide/neptoon-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](https://codebase.helmholtz.cloud/cosmos/neptoon/-/issues)
- **Contact**: Email us at [neptoon-contact@ufz.de](mailto:neptoon-contact@ufz.de)
- **Contributing**: See the [contribution guidelines](https://www.neptoon.org/en/latest/contribution/overview-contribution/) for details on how to contribute
## Authors and Acknowledgments
**Lead Developers:**
- Daniel Power (daniel.power@ufz.de)
- Martin Schrön (martin.schroen@ufz.de)
**Additional Contributors:**
- Fredo Erxleben
- Steffen Zacharias
- Rafael Rosolem
## License
neptoon is licensed under the MIT License. See the [LICENSE](https://codebase.helmholtz.cloud/cosmos/neptoon/-/blob/main/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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "neptoon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "CRNS, Cosmic Ray Neutron Sensors, Cosmic Rays, crns, soil, soil moisture",
"author": null,
"author_email": "Daniel Power <dpower-rse@pm.me>, Martin Schroen <martin.schroen@ufz.de>",
"download_url": "https://files.pythonhosted.org/packages/37/18/666338cb92d5398ca08b8c377099390b3adb7904034dac246a21bb63e5ee/neptoon-0.13.3.tar.gz",
"platform": null,
"description": "# neptoon\n\n[](https://pypi.org/project/neptoon/)\n[](https://pypi.org/project/neptoon/)\n[](https://www.neptoon.org)\n[](https://codebase.helmholtz.cloud/cosmos/neptoon/-/blob/main/LICENSE)\n[](https://pepy.tech/projects/neptoon)\n\nneptoon is a Python package for processing Cosmic-Ray Neutron Sensor (CRNS) data to produce field-scale soil moisture estimates. \n\n## Key Features\n\n- **Modular Correction Pipeline**: Apply multiple correction methods for pressure, incoming intensity, humidity, and biomass\n- **Quality Assessment**: Built-in data quality checks integrated with [SaQC](https://rdm-software.pages.ufz.de/saqc/index.html)\n- **Sensor Calibration**: Tools for N0 calibration using soil sampling data\n- **External Data Integration**: Automatic integration with NMDB.eu for incoming neutron corrections\n- **Multiple Interfaces**: Use via Python API, configuration files, or GUI\n- **Published Science**: Implementations based on peer-reviewed methodologies\n- **Reproducibility**: Built-in reporting, reproduceable workflows, and comprehensive documentation\n\n## Installation\n\n### Basic Installation\n\n```bash\npip install neptoon\n```\n\n### GUI Installation\n\n```bash\npipx install \"neptoon[gui]\"\n```\n\n### Recommended Installation (Isolated Environment)\n\n```bash\n# Create a new environment with Python 3.10\nconda create -n neptoon python=3.10 ipykernel\nconda activate neptoon\npip install neptoon\n```\n\nFor more detailed installation instructions, see the [installation documentation](https://www.neptoon.org/en/latest/user-guide/installation/).\n\n## Quick Start\n\n```python\nfrom neptoon.io.read import DataHubFromConfig\nfrom neptoon.workflow.process_with_yaml import ProcessWithConfig\nfrom neptoon.config import ConfigurationManager\n\n# Load configurations\nconfig = ConfigurationManager()\nconfig.load_configuration(file_path=\"path/to/sensor_config.yaml\")\nconfig.load_configuration(file_path=\"path/to/processing_config.yaml\")\n\n# Process data\nyaml_processor = ProcessWithConfig(configuration_object=config)\nyaml_processor.run_full_process()\n```\n\nReady-to-use examples with sample data are available in the [neptoon_examples repository](https://codebase.helmholtz.cloud/cosmos/neptoon_examples).\n\n## Documentation\n\nComprehensive documentation is available at:\n- [www.neptoon.org](https://www.neptoon.org) - Main documentation\n- [User Guide](https://www.neptoon.org/en/latest/user-guide/workflow-description/) - Detailed workflow description\n- [Examples](https://www.neptoon.org/en/latest/user-guide/neptoon-examples/) - Practical examples and tutorials\n\n## Project Status\n\nneptoon is currently in active development. Version 1.0, focusing on stability and robustness, is expected soon. Future plans include:\n\n- Roving CRNS processing capabilities\n- Server/Docker versions for automated processing\n\n## Support and Contribution\n\n- **Issues**: Report bugs or request features through [GitLab issues](https://codebase.helmholtz.cloud/cosmos/neptoon/-/issues)\n- **Contact**: Email us at [neptoon-contact@ufz.de](mailto:neptoon-contact@ufz.de)\n- **Contributing**: See the [contribution guidelines](https://www.neptoon.org/en/latest/contribution/overview-contribution/) for details on how to contribute\n\n## Authors and Acknowledgments\n\n**Lead Developers:**\n- Daniel Power (daniel.power@ufz.de)\n- Martin Schr\u00f6n (martin.schroen@ufz.de)\n\n**Additional Contributors:**\n- Fredo Erxleben\n- Steffen Zacharias\n- Rafael Rosolem\n\n## License\n\nneptoon is licensed under the MIT License. See the [LICENSE](https://codebase.helmholtz.cloud/cosmos/neptoon/-/blob/main/LICENSE) file for details.\n\n## Citation\n\nIf you use neptoon in your research, please cite:\n\n```\nPower, D., Erxleben, F., Zacharias, S., Rosolem, R., & Schr\u00f6n, M. (2025). neptoon (v0.8.2). Helmholtz Zentrum f\u00fcr Umweltforschung. https://doi.org/10.5281/zenodo.15181751\n```",
"bugtrack_url": null,
"license": null,
"summary": "The neptoon package makes CRNS processing and research simple.",
"version": "0.13.3",
"project_urls": {
"Documentation": "https://www.neptoon.org",
"Homepage": "https://www.neptoon.org",
"Repository": "https://codebase.helmholtz.cloud/cosmos/neptoon"
},
"split_keywords": [
"crns",
" cosmic ray neutron sensors",
" cosmic rays",
" crns",
" soil",
" soil moisture"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "19f14e236d69085313494c631fc6d7c51287366f1bce35f42437e91ba22f9537",
"md5": "98f7174b316c4660c590fd337aa24f3c",
"sha256": "f70c69f319ebbb1bfe3207b0a3b3ab5ff6d3900426d67a77de30f1e55156010e"
},
"downloads": -1,
"filename": "neptoon-0.13.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "98f7174b316c4660c590fd337aa24f3c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3362478,
"upload_time": "2025-09-19T12:19:50",
"upload_time_iso_8601": "2025-09-19T12:19:50.774434Z",
"url": "https://files.pythonhosted.org/packages/19/f1/4e236d69085313494c631fc6d7c51287366f1bce35f42437e91ba22f9537/neptoon-0.13.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3718666338cb92d5398ca08b8c377099390b3adb7904034dac246a21bb63e5ee",
"md5": "9c1fc004f704208dd256c6864feff6d5",
"sha256": "69ddcf4b8b7bd16388e3ace31ea90904b982552040bbd7229adec4c16f0601bf"
},
"downloads": -1,
"filename": "neptoon-0.13.3.tar.gz",
"has_sig": false,
"md5_digest": "9c1fc004f704208dd256c6864feff6d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 5410514,
"upload_time": "2025-09-19T12:19:53",
"upload_time_iso_8601": "2025-09-19T12:19:53.169620Z",
"url": "https://files.pythonhosted.org/packages/37/18/666338cb92d5398ca08b8c377099390b3adb7904034dac246a21bb63e5ee/neptoon-0.13.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-19 12:19:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "neptoon"
}
JSON