FirnCorr

Python-based tools for correcting data for surface mass balance and firn processes

About

Tests:
License:

For more information: see the documentation at firncorr.readthedocs.io

Installation

Development version from GitHub:

python3 -m pip install git+https://github.com/tsutterley/FirnCorr.git

Running with Pixi

Alternatively, you can use Pixi for a streamlined workspace environment:

1. Install Pixi following the installation instructions
2. Clone the project repository:

git clone https://github.com/tsutterley/FirnCorr.git

3. Move into the FirnCorr directory

cd FirnCorr

4. Install dependencies and start JupyterLab:

pixi run start

This will automatically create the environment, install all dependencies, and launch JupyterLab in the notebooks directory.

Dependencies

• h5netcdf: Pythonic interface to netCDF4 via h5py
• lxml: processing XML and HTML in Python
• numpy: Scientific Computing Tools For Python
• platformdirs: Python module for determining platform-specific directories
• pyproj: Python interface to PROJ library
• scipy: Scientific Tools for Python
• timescale: Python tools for time and astronomical calculations
• xarray: N-D labeled arrays and datasets in Python

References

B. E. Smith, B. Medley, X. Fettweis, T. Sutterley, P. Alexander, D. Porter, and M. Tedesco, "Evaluating Greenland surface-mass-balance and firn-densification data using ICESat-2 altimetry", The Cryosphere, 17(2), 789-808, (2023). doi: 10.5194/tc-17-789-2023

T. C. Sutterley, I. Velicogna, X. Fettweis, E. Rignot, B. Noël, and M. van den Broeke, "Evaluation of Reconstructions of Snow/Ice Melt in Greenland by Regional Atmospheric Climate Models Using Laser Altimetry Data", Geophysical Research Letters, 45(16), 8324-8333, (2018). doi: 10.1029/2018GL078645

Alternative Software

SMB correction tools built upon pointCollection:
https://github.com/tsutterley/SMBcorr

Download

The program homepage is:
https://github.com/tsutterley/FirnCorr

A zip archive of the latest version is available directly at:
https://github.com/tsutterley/FirnCorr/archive/main.zip

Disclaimer

This package includes software developed at NASA Goddard Space Flight Center (GSFC) and the University of Washington Applied Physics Laboratory (UW-APL). It is not sponsored or maintained by the Universities Space Research Association (USRA), AVISO or NASA. The software is provided here for your convenience but with no guarantees whatsoever.

Contributing

This project contains work and contributions from the scientific community. If you would like to contribute to the project, please have a look at the contribution guidelines, open issues and discussions board.

License

The content of this project is licensed under the Creative Commons Attribution 4.0 Attribution license and the source code is licensed under the MIT license.