Skip to content

Commit

Permalink
Documentation updated with conda installation and version update (#210)
Browse files Browse the repository at this point in the history
* Conda documentation added

* badge spacing

* noarch badge added

* conda first

* Metadata project info changed
  • Loading branch information
PennyHow committed Nov 10, 2023
1 parent 06b83da commit ec99e7c
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 10 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# pypromice
[![PyPI version](https://badge.fury.io/py/pypromice.svg)](https://badge.fury.io/py/pypromice)
[![](<https://img.shields.io/badge/Dataverse DOI-10.22008/FK2/3TSBF0-orange>)](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://img.shields.io/badge/Dataverse DOI-10.22008/FK2/3TSBF0-orange>)](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.

Expand All @@ -18,7 +17,11 @@ 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 conda or pip:

```
$ conda install pypromice -c conda-forge
```

```
$ pip install pypromice
Expand Down
10 changes: 8 additions & 2 deletions docs/install.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
*************
Quick install
*************
The latest release of pypromice can installed using pip:
The latest release of pypromice can installed using conda or pip:

.. code:: console
$ conda install pypromice -c conda-forge
.. code:: console
$ pip install pypromice
For the most up-to-date version, pypromice can be installed directly from the repo:

.. code:: console
Expand All @@ -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 <https://github.com/GEUS-Glaciology-and-Climate/pypromice>`_.
pypromice can be ran in an environment with the pypromice package forked or cloned from the `GitHub repo <https://github.com/GEUS-Glaciology-and-Climate/pypromice>`_.

.. code:: console
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
6 changes: 3 additions & 3 deletions src/pypromice/process/metadata.csv
Original file line number Diff line number Diff line change
Expand Up @@ -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/."

0 comments on commit ec99e7c

Please sign in to comment.