Cosmic-Ray Neutron Python (CRNPy) Library

A Python toolbox for handling common tasks with cosmic-ray neutron probes. This release is based in version 0.6.0 but archived in zenodo.

v0.6.0

Including the corrections from the Journal of Open Source Software review

Summary:

• The method get_reference_neutron_flux was introduced, providing one value for the reference date, and having as a default date 2011-05-01, following previous studies (Zreda et a., 2012, Hawdon et al., 2014, Bogena et al., 2022).
• Rc_methods Hawdonetal2014 and McJannetandDesilets2023 were added to the routine correction_incoming_flux to account for differences in cutoff rigidity.
• Added the revised sample weighting procedure (Schrön et al., 2017).
• Functions with specifics pandas methods, were improved to be type agnostic.
• Code style improved

0.5.1

What's Changed

• Implemented uncertainty estimation methods.
• Corrected documentation

• Development by @joaquinperaza in #5
  Full Changelog: 0.5.0...0.5.1

0.5.0

• Corrections routines are reporting the correction factors, allowing a more transparent processing workflow
• count_time() method renamed to get_integration_time()
• Several documentation enhancements

Full Changelog: 0.4.1...0.5.0

0.4.1

• Fixed errors in count_time(), adjust_temporal_counts() and sensing_depth()
• Improved documentation

0.4.0

Version 0.4.0 Release Notes:

This release marks a significant update from the 0.3.x series and includes several enhancements, improvements, and breaking changes based on feedback and the need for more accurate and clear functionalities. We have incremented the minor version to 0.4.x to indicate these breaking changes and to prevent compatibility issues.

Key updates include:

• Renamed normalize_counts() to adjust_temporal_counts() to better reflect the functionality of the method.
• Split the atm_correction() method into separate functions for water vapor and pressure corrections. This change provides more flexibility and clarity but deprecates the atm_correction() method.
• Replaced find_neutron_detector() with find_neutron_monitor() to accurately represent the functionality.
• Improved figures in examples by adding axis labels and units for better understanding.
• Renamed smooth_2d() to spatial_average() to align with common terminology.
• Updated rover data processing to compute center coordinates for more accurate data representation.
• Added computation of sensing depth in a stationary detector example for more detailed analysis.
• Reviewed and addressed issues regarding depth-weights using bulk density for more accurate calculations.

0.3.2

Full Changelog: 0.3.1...0.3.2

Changes in this version:

Source Code:

• Updated method signatures for count_time, fill_counts, normalize_counts, and compute_total_raw_counts to include a new parameter timestamp_col.
• Improved error handling and validation in methods.

Documentation:

• Added an overview of the CRNPy processing workflow with images.
• Corrected mathematical formulas.

Examples:

• Updated content in Jupyter Notebook examples.

0.3.1

Fixed examples with workflow graphics and better descriptions.
Fixed documentation errors.
Absolute path to GitHub resources in examples added.
First release for beta testing.

Full Changelog: v0.3-1...0.3.1

v0.3-1

• Improved documentation
• Calibration methods implemented
• Device calibration example created

Test package release workflow

Full Changelog: v0.0.1-alpha...v0.0.2-alpha