Skip to content

Commit

Permalink
pypi build for JOSS review (#143)
Browse files Browse the repository at this point in the history
* pypi publish action added

* pypi token added

* pip install updated
  • Loading branch information
PennyHow committed May 16, 2023
1 parent 4b9c039 commit f51c4d7
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 4 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/pypi-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# This workflow will upload a Python Package using Twine when a release is created
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

name: Upload Python Package

on:
release:
types: [published]

permissions:
contents: read

jobs:
deploy:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build
- name: Build package
run: python -m build --sdist --wheel --outdir dist/
- name: Publish package
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
with:
user: __token__
password: ${{ secrets.PYPI_TOKEN }}
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,20 @@ If you intend to use PROMICE AWS data and/or pypromice in your work, please cite

**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](https://doi.org/10.5194/essd-13-3819-2021)**

**How, P., Wright, P.J., Mankoff, K., Vandecrux, B. (2023) pypromice, GEUS Dataverse, [https://doi.org/10.22008/FK2/3TSBF0](https://doi.org/10.22008/FK2/3TSBF0)**
**How, P., Wright, P.J., Mankoff, K., and Vandecrux, B. (2023) pypromice v1.0.0, GEUS Dataverse, [https://doi.org/10.22008/FK2/3TSBF0](https://doi.org/10.22008/FK2/3TSBF0)**


## Installation

### Quick install

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

```
$ pip install pypromice
```

For the most up-to-date version, pypromice can be installed directly from the repo:

```
$ pip install --upgrade git+http://github.com/GEUS-Glaciology-and-Climate/pypromice.git
Expand Down Expand Up @@ -50,3 +56,4 @@ If the environment cannot resolve the eccodes installation then follow the steps
```
$ pip3 install eccodes-python
```

2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ If you intend to use PROMICE and GC-Net AWS data and/or pypromice in your work,

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. (2023) pypromice, GEUS Dataverse, https://doi.org/10.22008/FK2/3TSBF0
How, P., Wright, P.J., Mankoff, K. and Vandecrux, B. (2023) pypromice v1.0.0, GEUS Dataverse, https://doi.org/10.22008/FK2/3TSBF0

.. _pypromice: https://github.com/GEUS-Glaciology-and-Climate/pypromice
.. _PROMICE: https://promice.dk
Expand Down
8 changes: 7 additions & 1 deletion docs/install.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
*************
Quick install
*************
pypromice can installed using pip:
The latest release of pypromice can installed using pip:

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

.. code:: console
Expand Down

0 comments on commit f51c4d7

Please sign in to comment.