Skip to content

Commit

Permalink
Updated sentence about Corny library
Browse files Browse the repository at this point in the history
  • Loading branch information
Andres Patrignani committed Apr 19, 2024
1 parent f27f83c commit 3f5cb80
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 1 deletion.
Binary file removed docs/.DS_Store
Binary file not shown.
Binary file removed docs/img/.DS_Store
Binary file not shown.
2 changes: 1 addition & 1 deletion paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ CRNPy is a Python library that facilitates the processing, analysis, and convers

# Statement of Need

Cosmic ray neutron probes (CRNP) are non-invasive soil moisture sensors that fill the niche between point-level and satellite sensors. However, the conversion of raw CRNP data into soil moisture requires multiple corrections and filtering steps that are described across various peer-reviewed articles. To circumvent this limitation and enhance reproducibility, the CRNPy library offers a simple, instrument-agnostic, and integrated solution with minimal dependencies. Compared to the existing `crspy`[@power2021cosmic] library, CRNPy avoids stringent data naming conventions and external data requirements. A flexible data naming convention enables a seamless integration with output files from different instrument manufacturers and the lack of external data requirements makes the library more compact (only ~65 KB) and straight forward to install. Compared to the `corny` [@cornish_pasdy], a more integrated software implementing an end-to-end solution, CRNPy's modular design based on Python functions promotes integration and reproducibility within data analysis pipelines and interactive development environments like Jupyter Lab notebooks. In addition, its straightforward installation using the Python Package Index, the minimal dependencies—most included with the Anaconda open-source ecosystem—and the comprehensive datasets with included examples in the form of Jupyter notebooks, provide an accessible start for CRNP data processing. The CRNPy library emphasizes easy maintenance and community-driven improvements since users can expand its capabilities by adding regular Python functions to the core module. The compact size and simple structure of the CRNPy library can also enable future integration into cloud-based services, IoT sensors, and system-on-chip technologies, broadening its use and customization potential.
Cosmic ray neutron probes (CRNP) are non-invasive soil moisture sensors that fill the niche between point-level and satellite sensors. However, the conversion of raw CRNP data into soil moisture requires multiple corrections and filtering steps that are described across various peer-reviewed articles. To circumvent this limitation and enhance reproducibility, the CRNPy library offers a simple, instrument-agnostic, and integrated solution with minimal dependencies. Compared to the existing `crspy`[@power2021cosmic] library, CRNPy avoids stringent data naming conventions and external data requirements. A flexible data naming convention enables a seamless integration with output files from different instrument manufacturers and the lack of external data requirements makes the library more compact (only ~65 KB) and straight forward to install. Compared to `corny` [@cornish_pasdy], which is another community-driven collection of useful and extensible python functions to do CRNP data processing, CRNPy's provides: 1) a slightly more modular design based on Python functions that promotes integration and reproducibility within data analysis pipelines and interactive development environments, and 2) a more accessible and complete online documentation. The CRNPy library was developed with Jupyter notebooks in mind. In addition, its straightforward installation using the Python Package Index, the minimal dependencies—most included with the Anaconda open-source ecosystem—and the comprehensive datasets with included examples in the form of Jupyter notebooks, provide an accessible start for CRNP data processing. The CRNPy library emphasizes easy maintenance and community-driven improvements since users can expand its capabilities by adding regular Python functions to the core module. The compact size and simple structure of the CRNPy library can also enable future integration into cloud-based services, IoT sensors, and system-on-chip technologies, broadening its use and customization potential.

# Library features

Expand Down

0 comments on commit 3f5cb80

Please sign in to comment.