Skip to content

GEUS-Glaciology-and-Climate/pypromice

Repository files navigation

pypromice

PyPI version Anaconda-Server Badge Anaconda-Server Badge DOI Documentation Status

pypromice is designed for processing and handling PROMICE automated weather station (AWS) data.

It is envisioned for pypromice to be the go-to toolbox for handling and processing PROMICE and GC-Net datasets. New releases of pypromice are uploaded alongside PROMICE AWS data releases to our Dataverse for transparency purposes and to encourage collaboration on improving our data. Please visit the pypromice readthedocs for more information.

If you intend to use PROMICE AWS data and/or pypromice in your work, please cite these publications below, along with any other applicable PROMICE publications where possible:

Fausto, R.S., van As, D., Mankoff, K.D., Vandecrux, B., Citterio, M., Ahlstrøm, A.P., Andersen, S.B., Colgan, W., Karlsson, N.B., Kjeldsen, K.K., Korsgaard, N.J., Larsen, S.H., Nielsen, S., Pedersen, A.Ø., Shields, C.L., Solgaard, A.M., and Box, J.E. (2021) Programme for Monitoring of the Greenland Ice Sheet (PROMICE) automatic weather station data, Earth Syst. Sci. Data, 13, 3819–3845, https://doi.org/10.5194/essd-13-3819-2021

How, P., Wright, P.J., Mankoff, K., Vandecrux, B., Fausto, R.S. and Ahlstrøm, A.P. (2023) pypromice: A Python package for processing automated weather station data, Journal of Open Source Software, 8(86), 5298, https://doi.org/10.21105/joss.05298

How, P., Lund, M.C., Nielsen, R.B., Ahlstrøm, A.P., Fausto, R.S., Larsen, S.H., Mankoff, K.D., Vandecrux, B., Wright, P.J. (2023) pypromice, GEUS Dataverse, https://doi.org/10.22008/FK2/3TSBF0

Installation

Quick install

The latest release of pypromice can installed using conda or pip:

$ conda install pypromice -c conda-forge
$ pip install pypromice

The eccodes package for pypromice's post-processing functionality needs to be installed specifically in the pip distribution:

$ conda install eccodes -c conda-forge
$ pip install pypromice

And for the most up-to-date version of pypromice, the package can be cloned and installed directly from the repo:

$ pip install --upgrade git+http://github.com/GEUS-Glaciology-and-Climate/pypromice.git

Developer install

pypromice can be ran in an environment with the pypromice repo:

$ conda create --name pypromice python=3.8
$ conda activate pypromice
$ git clone git@github.com:GEUS-Glaciology-and-Climate/pypromice.git
$ cd pypromice/
$ pip install .