Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wpreimes committed Nov 4, 2024
1 parent c056b4d commit 08af156
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 21 deletions.
20 changes: 4 additions & 16 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,24 +53,12 @@ jobs:
shell: bash -l {0}
run: |
conda install -c conda-forge pygrib netcdf4 pyresample pykdtree
# On macos pykdtree was built with OpenMP (C-level parallelization library) support
if [ ${{ matrix.os }} == "macos-latest" ]
then
conda install -c conda-forge pykdtree
fi
# And on windows pygrib wheels are not available
if [ ${{ matrix.os }} == "windows-latest" ]
then
conda install -c conda-forge pygrib
fi
pip install -e .[testing]
- name: Run all tests
env:
CDS_APIKEY: ${{ secrets.CDS_APIKEY }}
shell: bash -l {0}
run: |
run: |
pytest
- name: Export Environment
shell: bash -l {0}
Expand Down Expand Up @@ -153,8 +141,8 @@ jobs:
publish-docker-image:
name: Publish Docker 📦
# Will only trigger when Tests have passed on release/tag from the TUW-GEO repository
if: |
startsWith(github.ref, 'refs/tags/v') &&
if: |
startsWith(github.ref, 'refs/tags/v') &&
startsWith(github.repository, 'TUW-GEO')
needs: build
runs-on: ubuntu-latest
Expand Down Expand Up @@ -190,4 +178,4 @@ jobs:
with:
subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
subject-digest: ${{ steps.push.outputs.digest }}
push-to-registry: true
push-to-registry: true
11 changes: 6 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,23 +112,24 @@ pre-installed dependencies and can simply be pulled via
$ docker pull ghcr.io/tuw-geo/ecmwf_models:latest
Alternatively, to build the image locally using the Dockerfile, call
Alternatively, to build the image locally using the provided Dockerfile, call
from the package root

.. code-block:: shell
$ docker build ecmwf_models:latest . 2>&1 | tee docker_build.log
$ docker buildx build -t ecmwf_models:latest . 2>&1 | tee docker_build.log
Afterwards, you can execute the ``era5`` and ``era5land`` commands directly in
the container (after mounting some volumes to write data to).
The easiest way to set the API credentials in this case is via the environment
variable or the ``--cds_token`` option.
The easiest way to set the API credentials in this case is via the
``CDSAPI_KEY`` container variable or the ``--cds_token`` option as below.

.. code-block:: shell
$ docker run -v /data/era5/img:/container/path ecmwf_models:latest bash -c \
'era5land update_img /container/path --cds_token xxxx-xxx-xxx-xx-xxxx'
You can use this together with a task scheduler to regularly pull new data
You can use this together with a task scheduler to regularly pull new data.

Citation
========
Expand Down

0 comments on commit 08af156

Please sign in to comment.