CRNPy
CRNPy: An Open-Source Python Library for Cosmic-Ray Neutron Probe Data Processing - Published in JOSS (2024)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
1 of 3 committers (33.3%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Scientific Fields
Repository
A Python toolbox for handling common tasks with cosmic-ray neutron probes
Basic Info
- Host: GitHub
- Owner: soilwater
- License: other
- Language: HTML
- Default Branch: main
- Homepage: https://soilwater.github.io/crnpy/
- Size: 40.5 MB
Statistics
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 2
- Releases: 11
Topics
Metadata Files
README.md
Cosmic-Ray Neutron Python (CRNPy) Library
Overview
Welcome to the homepage of the CRNPy (Cosmic-Ray Neutron Python) library, an open-source Python library designed for the processing and conversion of raw neutron counts from cosmic-ray neutron probes (CRNP) into soil moisture data.
This library has been developed with the intent of providing a comprehensive yet easy-to-use workflow for processing raw data from a variety of CRNP, encompassing multiple manufacturers and models.
Statement of Need
CRNPs are a valuable tool for non-invasive soil moisture estimation at the hectometer scale (e.g., typical agricultural fields), filling the gap between point-level sensors and large-scale (i.e., several kilometers) remote sensors onboard orbiting satellites. However, cleaning, processing, and analyzing CRNP data involves multiple corrections and filtering steps spread across multiple peer-reviewed manuscripts. CRNPy simplifies these steps by providing a complete, user-friendly, and well-documented library with minimal dependencies that includes examples to convert raw CRNP data into soil moisture. The library is designed to be accessible to both researchers and instrument manufacturers. Unlike other similar libraries, CRNPy does not require any specific naming convention for the input data or large external data sources, or reanalysis data.
Key Features
Versatile and instrument agnostic: CRNPy can handle data from various CRNP manufacturers and models. It has been successfully tested on both roving and stationary CRNP.
Modular: The library is designed to be modular, allowing users to easily customize the processing workflow to their needs.
Installation
To install the CRNPy library, you can use Python's package manager. Open a terminal and type:
pip install crnpy
from the Jupyter notebook, type:
!pip install crnpy
Ideally dependencies should be installed automatically. If not, you can install them manually by typing:
pip install -r requirements.txt
The CRNPy library is compatible with Python 3.7 and above. See requirements.txt for a list of dependencies.
Examples
- https://soilwater.github.io/crnpy/examples/stationary/exampleRDTstation/
- https://soilwater.github.io/crnpy/examples/rover/Hydroinnovaroverexample/
- https://soilwater.github.io/crnpy/examples/calibration/calibration/
Authors
The CRNPy library was developed at the Kansas State University Soil Water Processes Lab by:
Joaquin Peraza
Andres Patrignani
The Soil Water Processes Lab at Kansas State University combines a range of experimental and computational approaches to tackle pressing issues in soil and water research. The development of the CRNPy library is a step forward to creating reproducible data processing workflows across the scientific community using cosmic-ray neutrons probes for soil moisture sensing.
Community Guidelines
Contributing
To contribute to the software, please first fork the repository and create your own branch from main. Ensure your code adheres to our established code structure and includes appropriate test/examples coverage. CRNPy source code is located in the /src/crnpy/ folder, and tests implemented using pytest are stored in the /src/tests/ folder. Submit a pull request with a clear and detailed description of your changes to include them in the main repository.
Reporting Issues
If you encounter any issues or problems with the software, please report them on our issues page. Include a detailed description of the issue, steps to reproduce the problem, any error messages you received, and details about your operating system and software version.
Seeking Support
If you need support, please first refer to the documentation. If you still require assistance, post a question on the issues page with the question tag. For private inquiries, you can reach us via email at jperaza@ksu.edu or andrespatrignani@ksu.edu.
Owner
- Name: soilwater
- Login: soilwater
- Kind: organization
- Repositories: 1
- Profile: https://github.com/soilwater
JOSS Publication
CRNPy: An Open-Source Python Library for Cosmic-Ray Neutron Probe Data Processing
Authors
Department of Agronomy, Kansas State University, Manhattan, KS, USA.
Department of Plant and Soil Sciences, Oklahoma State University, Stillwater, OK, USA.
Department of Agronomy, Kansas State University, Manhattan, KS, USA.
Editor
Jayaram Hariharan
Tags
Cosmic-Ray Neutron Probes Soil Moisture Data ProcessingGitHub Events
Total
- Fork event: 1
Last Year
- Fork event: 1
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Joaquin Peraza | j****n@p****y | 119 |
| Andres Patrignani | a****i@k****u | 8 |
| Andres Patrignani | a****i@u****s | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 7
- Total pull requests: 5
- Average time to close issues: 11 months
- Average time to close pull requests: 5 days
- Total issue authors: 3
- Total pull request authors: 1
- Average comments per issue: 0.86
- Average comments per pull request: 0.0
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- danpower101 (4)
- joaquinperaza (2)
- jlarsen-usgs (1)
Pull Request Authors
- joaquinperaza (5)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 89 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 10
- Total maintainers: 1
pypi.org: crnpy
A Python package for the estimation and processing of soil moisture data from cosmic-ray neutron counts.
- Homepage: https://soilwater.github.io/crnpy/
- Documentation: https://crnpy.readthedocs.io/
- License: MIT
-
Latest release: 0.6.1
published over 1 year ago