From 51731067fde834f3cba0a5ed654f0c386ec1bb86 Mon Sep 17 00:00:00 2001 From: PennyHow Date: Tue, 7 Nov 2023 10:06:53 -0200 Subject: [PATCH 1/5] Conda documentation added --- README.md | 11 +++++++---- docs/install.rst | 10 ++++++++-- setup.py | 2 +- 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e3ca5c5e..8cd98c18 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ # pypromice -[![PyPI version](https://badge.fury.io/py/pypromice.svg)](https://badge.fury.io/py/pypromice) -[![]()](https://www.doi.org/10.22008/FK2/3TSBF0) [![DOI](https://joss.theoj.org/papers/10.21105/joss.05298/status.svg)](https://doi.org/10.21105/joss.05298) [![Documentation Status](https://readthedocs.org/projects/pypromice/badge/?version=latest)](https://pypromice.readthedocs.io/en/latest/?badge=latest) +[![PyPI version](https://badge.fury.io/py/pypromice.svg)](https://badge.fury.io/py/pypromice)[![Anaconda-Server Badge](https://anaconda.org/conda-forge/pypromice/badges/version.svg)](https://anaconda.org/conda-forge/pypromice)[![]()](https://www.doi.org/10.22008/FK2/3TSBF0) [![DOI](https://joss.theoj.org/papers/10.21105/joss.05298/status.svg)](https://doi.org/10.21105/joss.05298) [![Documentation Status](https://readthedocs.org/projects/pypromice/badge/?version=latest)](https://pypromice.readthedocs.io/en/latest/?badge=latest) -pypromice is designed for processing and handling [PROMICE](https://promice.dk) automated weather station (AWS) data. +pypromice is designed for processing and handling [PROMICE](https://promice.org) automated weather station (AWS) data. It is envisioned for pypromice to be the go-to toolbox for handling and processing [PROMICE](https://promice.dk) and [GC-Net](http://cires1.colorado.edu/steffen/gcnet/) datasets. New releases of pypromice are uploaded alongside PROMICE AWS data releases to our [Dataverse](https://dataverse.geus.dk/dataverse/PROMICE) for transparency purposes and to encourage collaboration on improving our data. Please visit the pypromice [readthedocs](https://pypromice.readthedocs.io/en/latest/?badge=latest) for more information. @@ -18,12 +17,16 @@ If you intend to use PROMICE AWS data and/or pypromice in your work, please cite ### Quick install -The latest release of pypromice can installed using pip: +The latest release of pypromice can installed using pip or conda-forge: ``` $ pip install pypromice ``` +``` +$ conda install pypromice -c conda-forge +``` + For the most up-to-date version, pypromice can be installed directly from the repo: ``` diff --git a/docs/install.rst b/docs/install.rst index c5adb0aa..7c6dc3cb 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,12 +1,18 @@ ************* Quick install ************* -The latest release of pypromice can installed using pip: +The latest release of pypromice can installed using pip or conda-forge: .. code:: console $ pip install pypromice + +.. code:: console + + $ conda install pypromice -c conda-forge + + For the most up-to-date version, pypromice can be installed directly from the repo: .. code:: console @@ -17,7 +23,7 @@ For the most up-to-date version, pypromice can be installed directly from the re Developer install ***************** -pypromice can be ran in an environment with the pypromice package cloned from the `GitHub repo `_. +pypromice can be ran in an environment with the pypromice package forked or cloned from the `GitHub repo `_. .. code:: console diff --git a/setup.py b/setup.py index 92b18e3c..a487fbf3 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ setuptools.setup( name="pypromice", - version="1.3.1", + version="1.3.2", author="GEUS Glaciology and Climate", description="PROMICE/GC-Net data processing toolbox", long_description=long_description, From dfa042743c33674dacb713f84318eaf8856d3caf Mon Sep 17 00:00:00 2001 From: PennyHow Date: Tue, 7 Nov 2023 10:08:29 -0200 Subject: [PATCH 2/5] badge spacing --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8cd98c18..71565edb 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # pypromice -[![PyPI version](https://badge.fury.io/py/pypromice.svg)](https://badge.fury.io/py/pypromice)[![Anaconda-Server Badge](https://anaconda.org/conda-forge/pypromice/badges/version.svg)](https://anaconda.org/conda-forge/pypromice)[![]()](https://www.doi.org/10.22008/FK2/3TSBF0) [![DOI](https://joss.theoj.org/papers/10.21105/joss.05298/status.svg)](https://doi.org/10.21105/joss.05298) [![Documentation Status](https://readthedocs.org/projects/pypromice/badge/?version=latest)](https://pypromice.readthedocs.io/en/latest/?badge=latest) +[![PyPI version](https://badge.fury.io/py/pypromice.svg)](https://badge.fury.io/py/pypromice) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/pypromice/badges/version.svg)](https://anaconda.org/conda-forge/pypromice) [![]()](https://www.doi.org/10.22008/FK2/3TSBF0) [![DOI](https://joss.theoj.org/papers/10.21105/joss.05298/status.svg)](https://doi.org/10.21105/joss.05298) [![Documentation Status](https://readthedocs.org/projects/pypromice/badge/?version=latest)](https://pypromice.readthedocs.io/en/latest/?badge=latest) pypromice is designed for processing and handling [PROMICE](https://promice.org) automated weather station (AWS) data. From 0eef8aceadf948c35b7b719078a681b2bbd63e24 Mon Sep 17 00:00:00 2001 From: PennyHow Date: Tue, 7 Nov 2023 10:10:33 -0200 Subject: [PATCH 3/5] noarch badge added --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 71565edb..f2f17803 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # pypromice -[![PyPI version](https://badge.fury.io/py/pypromice.svg)](https://badge.fury.io/py/pypromice) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/pypromice/badges/version.svg)](https://anaconda.org/conda-forge/pypromice) [![]()](https://www.doi.org/10.22008/FK2/3TSBF0) [![DOI](https://joss.theoj.org/papers/10.21105/joss.05298/status.svg)](https://doi.org/10.21105/joss.05298) [![Documentation Status](https://readthedocs.org/projects/pypromice/badge/?version=latest)](https://pypromice.readthedocs.io/en/latest/?badge=latest) +[![PyPI version](https://badge.fury.io/py/pypromice.svg)](https://badge.fury.io/py/pypromice) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/pypromice/badges/version.svg)](https://anaconda.org/conda-forge/pypromice) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/pypromice/badges/platforms.svg)](https://anaconda.org/conda-forge/pypromice) [![]()](https://www.doi.org/10.22008/FK2/3TSBF0) [![DOI](https://joss.theoj.org/papers/10.21105/joss.05298/status.svg)](https://doi.org/10.21105/joss.05298) [![Documentation Status](https://readthedocs.org/projects/pypromice/badge/?version=latest)](https://pypromice.readthedocs.io/en/latest/?badge=latest) pypromice is designed for processing and handling [PROMICE](https://promice.org) automated weather station (AWS) data. From e05b86b4c9b605cef728e58ee1f4d8bd3fa2f992 Mon Sep 17 00:00:00 2001 From: PennyHow Date: Tue, 7 Nov 2023 10:18:48 -0200 Subject: [PATCH 4/5] conda first --- README.md | 6 +++--- docs/install.rst | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f2f17803..8813241e 100644 --- a/README.md +++ b/README.md @@ -17,14 +17,14 @@ If you intend to use PROMICE AWS data and/or pypromice in your work, please cite ### Quick install -The latest release of pypromice can installed using pip or conda-forge: +The latest release of pypromice can installed using conda or pip: ``` -$ pip install pypromice +$ conda install pypromice -c conda-forge ``` ``` -$ conda install pypromice -c conda-forge +$ pip install pypromice ``` For the most up-to-date version, pypromice can be installed directly from the repo: diff --git a/docs/install.rst b/docs/install.rst index 7c6dc3cb..7c005289 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,16 +1,16 @@ ************* Quick install ************* -The latest release of pypromice can installed using pip or conda-forge: +The latest release of pypromice can installed using conda or pip: .. code:: console - $ pip install pypromice - - + $ conda install pypromice -c conda-forge + + .. code:: console - $ conda install pypromice -c conda-forge + $ pip install pypromice For the most up-to-date version, pypromice can be installed directly from the repo: From d796bb76cb39240bcf31c60d14ec640cfffd1c6e Mon Sep 17 00:00:00 2001 From: PennyHow Date: Fri, 10 Nov 2023 11:42:02 -0200 Subject: [PATCH 5/5] Metadata project info changed --- src/pypromice/process/metadata.csv | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/pypromice/process/metadata.csv b/src/pypromice/process/metadata.csv index 62d7b6de..01b79ff5 100644 --- a/src/pypromice/process/metadata.csv +++ b/src/pypromice/process/metadata.csv @@ -50,7 +50,7 @@ publisher_institution,GEUS publisher_name,GEUS publisher_type,institution publisher_url,https://promice.dk -references,Fausto; R. S.; van As; D.; Mankoff; K. D.; Vandecrux; B.; Citterio; M.; Ahlstrom; A. P.; Andersen; S. B.; Colgan; W.; Karlsson; N. B.; Kjeldsen; K. K.; Korsgaard; N. J.; Larsen; S. H.; Nielsen; S.; Pedersen; A. O.; Shields; C. L.; Solgaard; A. M.; and Box; J. E.: 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; 2021. -references_bib,@article{Fausto2021; doi = {10.5194/essd-13-3819-2021}; url = {https://doi.org/10.5194/essd-13-3819-2021}; year = {2021}; month=8; publisher= {Copernicus {GmbH}}; volume = {13}; number = {8}; pages = {3819–3845}; author = {Robert S. Fausto and Dirk van As and Kenneth D. Mankoff and Baptiste Vandecrux and Michele Citterio and Andreas P. Ahlstr{\o}m and Signe B. Andersen and William Colgan and Nanna B. Karlsson and Kristian K. Kjeldsen and Niels J. Korsgaard and Signe H. Larsen and S{\o}ren Nielsen and Allan {\O}. Pedersen and Christopher L. Shields and Anne M. Solgaard and Jason E. Box}; title = {Programme for Monitoring of the Greenland Ice Sheet ({PROMICE}) automatic weather station data}; journal = {Earth System Science Data}} +references,"How, P.; Abermann, J.; Ahlstrøm, A.P.; Andersen, S.B.; Box, J. E.; Citterio, M.; Colgan, W.T.; Fausto. R.S.; Karlsson, N.B.; Jakobsen, J.; Langley, K.; Larsen, S.H.; Mankoff, K.D.; Pedersen, A.Ø.; Rutishauser, A.; Shield, C.L.; Solgaard, A.M.; van As, D.; Vandecrux, B.; Wright, P.J., 2022, ""PROMICE and GC-Net automated weather station data in Greenland"", https://doi.org/10.22008/FK2/IW73UU, GEUS Dataverse" +references_bib,@article{How2022; doi = {10.22008/FK2/IW73UU}; url = {https://doi.org/10.22008/FK2/IW73UU}; year = {2022}; month=10; publisher= {GEUS Dataverse}; author = {Penelope How and Jakob Abermann and Andreas P. Ahlstr{\o}m and Signe B. Andersen and Jason E. Box and Michele Citterio and William Colgan and Robert S. Fausto and Nanna B. Karlsson and Jakob Jakobsen and Kirsty Langley and Signe Hillerup Larsen and Kenneth D. Mankoff and Allan {\O}. Pedersen and Anja Rutishauser and Christopher L. Shields and Anne M. Solgaard and Dirk van As and Baptiste Vandecrux}; title = {PROMICE and GC-Net automated weather station data in Greenland}; journal = {GEUS Dataverse}} standard_name_vocabulary,CF Standard Name Table (v77; 19 January 2021) -summary,"The Programme for Monitoring of the Greenland Ice Sheet (PROMICE) has been measuring climate and ice sheet properties since 2007. Currently the PROMICE automatic weather station network includes 25 instrumented sites in Greenland. Accurate measurements of the surface and near-surface atmospheric conditions in a changing climate is important for reliable present and future assessment of changes to the Greenland ice sheet. Here we present the PROMICE vision and methodology and each link in the production chain for obtaining and sharing quality-checked data. In this paper we mainly focus on the critical components for calculating the surface energy balance and surface mass balance. A user-contributable dynamic webbased database of known data quality issues is associated with the data products at https://github.com/GEUS-PROMICE/ PROMICE-AWS-data-issues/. As part of the living data option the datasets presented and described here are available at DOI: 10.22008/promice/data/aws, https://doi.org/10.22008/promice/data/aws" +summary,"The Programme for Monitoring of the Greenland Ice Sheet (PROMICE) and Greenland Climate Network (GC-Net) have been measuring climate and ice sheet properties since 2007 and 1995, respectively. The PROMICE weather station network monitors glacier mass balance in the melt zone of the Greenland Ice Sheet, providing ground truth data to calibrate mass budget models. GC-Net weather stations measure snowfall and surface properties in the accumulation zone, providing valuable knowledge on the Greenland Ice Sheet’s mass gain and climatology.Accurate measurements of the surface and near-surface atmospheric conditions in a changing climate is important for reliable present and future assessment of changes to the Greenland Ice Sheet. All measurements are handled and processed with pypromice, which is a peer-reviewed and freely available Python package with source code available at https://github.com/GEUS-Glaciology-and-Climate/pypromice. A user-contributable dynamic web-based database of known data quality issues is associated with the data products at https://github.com/GEUS-PROMICE/ PROMICE-AWS-data-issues/."