Data

Tools

Indexes

Applications

Experiments

Open Source Science

neptoon

Extensible Python tool for processing and analysing Cosmic-Ray Neutron Sensor (CRNS) data

https://github.com/globalcosmos/neptoon

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.4%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

Extensible Python tool for processing and analysing Cosmic-Ray Neutron Sensor (CRNS) data

Basic Info
  • Host: GitHub
  • Owner: globalcosmos
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 30 MB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed 10 months ago
Metadata Files
Readme Changelog License Citation Codemeta

README.md

neptoon

PyPI version Python Version Documentation License PyPI Downloads

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

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.

Quick Start

```python from neptoon.io.read import DataHubFromConfig from neptoon.workflow.processwithyaml import ProcessWithConfig from neptoon.config import ConfigurationManager

Load configurations

config = ConfigurationManager() config.loadconfiguration(filepath="path/to/sensorconfig.yaml") config.loadconfiguration(filepath="path/to/processingconfig.yaml")

Process data

yamlprocessor = ProcessWithConfig(configurationobject=config) yamlprocessor.runfull_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

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 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

Owner

  • Name: globalcosmos
  • Login: globalcosmos
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
message: If you use this software, please cite the paper describing it as below. Specific
  versions of the software can additionally be referenced using individual DOIs.
type: software
title: neptoon
abstract: A Python processing toolbox for Cosmic Ray Neutron Sensors (CRNS)
doi: 10.5281/zenodo.16882952
version: v0.13.0
date-released: 2025-08-15
authors:
- given-names: Daniel
  family-names: Power
- given-names: Martin
  family-names: Schrön
- given-names: Fredo
  family-names: Erxleben
- given-names: Rafael
  family-names: Rosolem
- given-names: Steffen
  family-names: Zacharias
license: MIT
repository-code: git+https://codebase.helmholtz.cloud/cosmos/neptoon
identifiers:
- description: This is the archived snapshot of version v0.13.0 of neptoon
  type: doi
  value: 10.5281/zenodo.16882952

CodeMeta (codemeta.json) 

{
  "@context": "https://w3id.org/codemeta/3.0",
  "type": "SoftwareSourceCode",
  "author": [
    {
      "id": "https://orcid.org/0000-0002-0829-8580",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Helmholtz Zentrum fr Umweltforschung"
      },
      "email": "daniel.power@ufz.de",
      "familyName": "Power",
      "givenName": "Daniel"
    },
    {
      "type": "Role",
      "schema:author": "https://orcid.org/0000-0002-0829-8580",
      "roleName": "Maintainer",
      "startDate": "2024-11-01"
    },
    {
      "id": "https://orcid.org/0000-0002-0220-0677",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Helmholtz Zentrum fr Umweltforschung"
      },
      "email": "martin.schroen@ufz.de",
      "familyName": "Schrn",
      "givenName": "Martin"
    },
    {
      "type": "Role",
      "schema:author": "https://orcid.org/0000-0002-0220-0677",
      "roleName": "Maintainer",
      "startDate": "2024-11-01"
    },
    {
      "id": "https://orcid.org/0000-0001-7233-3005",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Helmholtz-Zentrum Dresden-Rossendorf"
      },
      "email": "f.erxleben@hzdr.de",
      "familyName": "Erxleben",
      "givenName": "Fredo"
    },
    {
      "id": "https://orcid.org/0000-0002-4914-692X",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "University of Bristol"
      },
      "email": "Rafael.Rosolem@bristol.ac.uk",
      "familyName": "Rosolem",
      "givenName": "Rafael"
    },
    {
      "id": "https://orcid.org/0000-0002-7825-0072",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Helmholtz Zentrum fr Umweltforschung"
      },
      "email": "steffen.zacharias@ufz.de",
      "familyName": "Zacharias",
      "givenName": "Steffen"
    }
  ],
  "codeRepository": "git+https://codebase.helmholtz.cloud/cosmos/neptoon",
  "contributor": {
    "id": "_:contributor_1",
    "type": "Person",
    "affiliation": {
      "type": "Organization",
      "name": "Universitt Potsdam"
    },
    "email": "till.francke@uni-potsdam.de",
    "familyName": "Francke",
    "givenName": "Till"
  },
  "dateCreated": "2024-11-01",
  "datePublished": "2025-09-25",
  "description": "A Python processing toolbox for Cosmic Ray Neutron Sensors (CRNS)",
  "license": "https://spdx.org/licenses/MIT",
  "name": "neptoon",
  "programmingLanguage": "Python 3",
  "developmentStatus": "wip",
  "issueTracker": "https://codebase.helmholtz.cloud/cosmos/neptoon/-/issues",
  "version": "v0.13.7",
  "dateModified": "2025-09-26",
  "@id": "https://doi.org/10.5281/zenodo.17209376",
  "identifier": [
    {
      "@type": "PropertyValue",
      "propertyID": "DOI",
      "value": "10.5281/zenodo.17209376"
    },
    {
      "@type": "PropertyValue",
      "propertyID": "Zenodo",
      "value": 17209376
    }
  ]
}

GitHub Events

Total
  • Watch event: 2
  • Delete event: 40
  • Public event: 1
  • Push event: 225
  • Create event: 87
Last Year
  • Watch event: 2
  • Delete event: 40
  • Public event: 1
  • Push event: 225
  • Create event: 87

Dependencies

poetry.lock pypi
  • annotated-types 0.7.0
  • black 24.10.0
  • certifi 2024.12.14
  • charset-normalizer 3.4.1
  • click 8.1.8
  • colorama 0.4.6
  • contourpy 1.3.1
  • cycler 0.12.1
  • defusedxml 0.7.1
  • docstring-parser 0.16
  • exceptiongroup 1.2.2
  • fancy-collections 0.3.0
  • fastdtw 0.3.4
  • figurex 0.2.12
  • flake8 7.1.1
  • fonttools 4.55.3
  • fpdf2 2.8.2
  • habanero 1.2.6
  • idna 3.10
  • iniconfig 2.0.0
  • joblib 1.4.2
  • kiwisolver 1.4.8
  • loguru 0.7.3
  • magazine 0.3.6
  • matplotlib 3.10.0
  • mccabe 0.7.0
  • multimethod 1.10
  • mypy-extensions 1.0.0
  • neatlogger 0.1.2
  • numpy 1.26.4
  • outlier-utils 0.0.5
  • packaging 24.2
  • pandas 2.2.3
  • pandera 0.18.3
  • pathspec 0.12.1
  • pillow 11.1.0
  • platformdirs 4.3.6
  • pluggy 1.5.0
  • pyaml 23.12.0
  • pyarrow 15.0.2
  • pycodestyle 2.12.1
  • pydantic 2.10.5
  • pydantic-core 2.27.2
  • pyflakes 3.2.0
  • pyparsing 3.2.1
  • pytest 8.3.4
  • python-dateutil 2.9.0.post0
  • pytz 2024.2
  • pyyaml 6.0.2
  • requests 2.32.3
  • saqc 2.6.0
  • scikit-learn 1.6.1
  • scipy 1.15.1
  • seaborn 0.13.2
  • six 1.17.0
  • sliceable-dict 0.4.1
  • threadpoolctl 3.5.0
  • tomli 2.2.1
  • tqdm 4.67.1
  • typeguard 4.4.1
  • typing-extensions 4.12.2
  • typing-inspect 0.9.0
  • tzdata 2024.2
  • urllib3 2.3.0
  • win32-setctime 1.2.0
  • wrapt 1.17.2
pyproject.toml pypi
  • black ^24.1.1 develop
  • PyYAML ^6.0.1
  • figurex ^0.2.10
  • flake8 ^7.0.0
  • magazine ^0.3.2
  • pandas ^2.2.0
  • pandera ^0.18.0
  • platformdirs ^4.2.0
  • pyaml ^23.12.0
  • pyarrow ^15.0.0
  • pydantic ^2.6.1
  • pytest ^8.0.0
  • python ^3.10
  • python-dateutil ^2.8.2
  • requests ^2.31.0
  • saqc ^2.6.0
  • seaborn ^0.13.2
  • urllib3 ^2.2.0