Replace environment.yml with conda-lock.yml

.github/workflows/ci.yml

@@ -19,7 +19,8 @@ jobs:
       - uses: actions/checkout@v3
       - uses: mamba-org/setup-micromamba@v1
         with:
-          environment-file: environment.yml
+          environment-file: conda-lock.yml
+          environment-name: ci
           cache-environment: true
           init-shell: bash
       - name: Install dependencies

.github/workflows/sonar.yml

@@ -16,7 +16,8 @@ jobs:
       - name: Set up Python
         uses: mamba-org/setup-micromamba@v1
         with:
-          environment-file: environment.yml
+          environment-file: conda-lock.yml
+          environment-name: ci
           cache-environment: true
           init-shell: bash
       - name: Install dependencies

.pre-commit-config.yaml

@@ -15,9 +15,10 @@ repos:
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
   - repo: https://github.com/adrienverge/yamllint
-    rev: "v1.29.0"
+    rev: "v1.35.1"
     hooks:
       - id: yamllint
+        exclude: conda-lock.yml
   - repo: https://github.com/psf/black
     rev: "22.3.0"
     hooks:

CHANGELOG.md

@@ -6,6 +6,11 @@ Formatted as described on [https://keepachangelog.com](https://keepachangelog.co
 
 ## [Unreleased]
 
+## Changed
+
+- Use [conda-lock](https://conda.github.io/conda-lock/) to install reproducible conda dependencies. Instead of loosely pinned environment.yml ([#442](https://github.com/eWaterCycle/ewatercycle/pull/442))
+- Esmvaltool is no longer a Python dependency, but a conda dependency ([#442](https://github.com/eWaterCycle/ewatercycle/pull/442))
+
 ### [2.2.0] (2024-07-08)
 
 ### Added

CONTRIBUTING.md

@@ -53,8 +53,10 @@ The sections below outline the steps in each case.
     repository (follow the instructions
     [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/)
     and [here](https://help.github.com/articles/syncing-a-fork/));
-4. install the package in editable mode and its dependencies with
-    `pip3 install -e .[dev]`;
+4. install package main and dev dependencies in a conda environment with
+    `conda-lock install -n ewatercycle` and activate it with `conda activate ewatercycle`;
+4. install the package in editable mode with
+    `pip3 install -e .`;
 4. make sure pre commit hook is installed by running `pre-commit install`, causes linting and formatting to be applied during commit;
 5. make sure the existing tests still work by running `pytest`;
 6. make sure the existing documentation can still by generated without
@@ -79,22 +81,23 @@ your pull request.
 This section is for maintainers of the package.
 
 1. Checkout ``HEAD`` of ``main`` branch with ``git checkout main`` and ``git pull``.
-2. Determine what new version (major, minor or patch) to use. Package uses `semantic versioning <https://semver.org>`_.
-3. Run ``bump2version <major|minor|patch>`` to update version in package files.
-4. Update CHANGELOG.md with changes between current and new version. (Don't forget to also update the links at the bottom of the file)
-5. Make sure pre-commit hooks are green for all files by running ``pre-commit run --all-files``.
-6. Commit & push changes to GitHub.
-7. Wait for [GitHub
+2. If dependencies have changed then create a new [conda lock](https://conda.github.io/conda-lock/) file with ``conda-lock lock -f pyproject.toml``.
+3. Determine what new version (major, minor or patch) to use. Package uses `semantic versioning <https://semver.org>`_.
+4. Run ``bump2version <major|minor|patch>`` to update version in package files.
+5. Update CHANGELOG.md with changes between current and new version. (Don't forget to also update the links at the bottom of the file)
+6. Make sure pre-commit hooks are green for all files by running ``pre-commit run --all-files``.
+7. Commit & push changes to GitHub.
+8. Wait for [GitHub
     actions](https://github.com/eWaterCycle/ewatercycle/actions?query=branch%3Amain+)
     to be completed and green.
 
-8. Create a [GitHub release](https://github.com/eWaterCycle/ewatercycle/releases/new)
+9. Create a [GitHub release](https://github.com/eWaterCycle/ewatercycle/releases/new)
 
     - Use version as title and tag version.
     - As description use intro text from README.md (to give context to
         Zenodo record) and changes from CHANGELOG.md
 
-9.  Verify
+10. Verify
 
     1. Has [new Zenodo
         record](https://zenodo.org/search?page=1&size=20&q=ewatercycle)
@@ -107,4 +110,4 @@ This section is for maintainers of the package.
     4. Can new version be installed with pip using
         `pip3 install ewatercycle==<new version>`?
 
-10. Celebrate
+11. Celebrate

README.md

@@ -35,9 +35,9 @@ generate forcing data. It is preferred to create a Conda environment to
 install those dependencies:
 
 ```shell
-wget https://raw.githubusercontent.com/eWaterCycle/ewatercycle/main/environment.yml
-conda install mamba -n base -c conda-forge -y
-mamba env create --file environment.yml
+wget https://raw.githubusercontent.com/eWaterCycle/ewatercycle/main/conda-lock.yml
+conda install mamba conda-lock -n base -c conda-forge -y
+conda-lock install --no-dev -n ewatercycle
 conda activate ewatercycle
 ```