Replace environment.yml with conda-lock.yml

[sverhoeven]

TODO

• valid pyproject.toml for pip install -e .[dev]

Refs #441

To check

• conda-lock lock on linux
• conda-lock install on linux
• pip install -e . should only install ewatercycle, only few additional deps should be installed
• pip install -e .[dev] should only install ewatercycle, few additional deps should be installed
• installing without conda should give instructions

[BSchilperoort]

I followed the instructions:

• environment downloaded successfully
• did pip install . --no-deps in checked out ewatercycle repo
• ran pytest and all tests passed 👍

However, I thought dev dependencies should not be added to the lock file but it seems like they did

[sverhoeven]

I followed the instructions:

• environment downloaded successfully
• did pip install . --no-deps in checked out ewatercycle repo
• ran pytest and all tests passed 👍

However, I thought dev dependencies should not be added to the lock file but it seems like they did

Switched to conda-lock install --no-dev for production install

[sverhoeven]

Hmm, pip install is installing black and tokenize-rt-5.2.0 . They have been removed in csdms/bmi-python#46 , but no new version has been released yet.

[BSchilperoort]

Hmm, pip install is installing black and tokenize-rt-5.2.0 . They have been removed in csdms/bmi-python#46 , but no new version has been released yet.

For me pip says it did the following:
Successfully installed black-24.4.2 ewatercycle-2.2.0 gitdir-1.2.7

And with .[dev]:
Installing collected packages: webencodings, wcwidth, snowballstemmer, pure-eval, ptyprocess, fastjsonschema, distlib, commonmark, virtualenv, types-requests, types-pyyaml, types-python-dateutil, traitlets, tokenize-rt, tinycss2, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, rpds-py, pyzmq, pytest-runner, pytest, pyproject_hooks, pygments, pycodestyle, prompt-toolkit, pexpect, parso, pandocfilters, ordered-set, nodeenv, mypy, mistune, mdurl, jupyterlab-pygments, isort, imagesize, identify, executing, docutils, decorator, coverage, cfgv, bump2version, bleach, babel, asttokens, astroid, alabaster, stack-data, sphinx, referencing, pre-commit, matplotlib-inline, markdown-it-py, jupyter-core, jedi, deepdiff, build, sphinxcontrib-jquery, sphinx-copybutton, sphinx-autoapi, rich, recommonmark, pytest-cov, jupyter-client, jsonschema-specifications, ipython, sphinx-rtd-theme, jsonschema, nbformat, nbclient, nbconvert, nbsphinx, ewatercycle

Which is normal as it's the dev+docs dependencies.

Perhaps edit the PR text:

pip install -e .[dev] should only install ewatercycle, no additonal deps should be installed

[BSchilperoort]

Tried out this branch. Encountered some issues.

---

1. Tried installing ewatercycle into python (no conda or esmvaltool). Got the following error:

image

Importlib changed with 🐍 3.10. Changing line 4 in ewatercycle/shared.py to:

from importlib.metadata import EntryPoint

fixes this issue.

---

2. currently import ewatercycle.forcing fails without esmvalcore/tool. This does not have to be this way. Want to fix that in a different PR? Would be nice to open an issue about it.

The import try/excepts can be moved to the methods which rely on esmvaltool, but still allow already generated forcing to be loaded (or e.g. caravanforcing which does not need esmvaltool)

---

Otherwise the conda-lock file seems to work well. It's also a lot faster, so stability + speed are both very nice to have.

[BSchilperoort]

Moving this to where it's used (i.e. def *Forcing.generate(...)) would allow users to mostly use ewatercycle without esmvaltool.

[sverhoeven]

1. Using importlib from standard library
2. Delayed optonal esmvaltool to Esmvaltool optional #447

[sonarcloud]

Quality Gate failed

Failed conditions
55.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

[sverhoeven]

https://ewatercycle.readthedocs.io/en/stable/system_setup.html#conda-environment) is still using wget https://raw.githubusercontent.com/eWaterCycle/ewatercycle/main/environment.yml which will fail. Can be resolved by making a new release.

[sverhoeven]

Fixes #357