Merge pull request #52 from mnlevy1981/update_conda_config

Update conda config

.github/workflows/deploy.yml

@@ -45,7 +45,7 @@ jobs:
       - name: Set up conda environment
         uses: mamba-org/setup-micromamba@v1
         with:
-            environment-file: build_envs/docs.yml
+            environment-file: environments/docs.yml
             cache-environment: true
             cache-environment-key: "docs-${{env.TODAY}}"
             create-args: >-
@@ -99,4 +99,4 @@ jobs:
 
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v2

README.md

@@ -30,15 +30,18 @@ $ ./manage_externals/checkout_externals
 Then build the necessary conda environments with
 
 ```
-$ conda env create -f cupid/dev-environment.yml
+$ mamba env create -f environments/dev-environment.yml
 $ conda activate cupid-dev
 $ which cupid-run
-$ conda env create -f cupid-analysis.yml
+$ mamba env create -f environments/cupid-analysis.yml
 ```
 
 Notes:
 
-1. `conda` now defaults to using `mamba` to solve environments; the `cupid-analysis.yml` environment is complicated, so older versions of `conda` should be updated (`conda update -n base conda`) or you should use `mamba` instead.
+1. As of version 23.10.0, `conda` defaults to using `mamba` to solve environments.
+It still feels slower than running `mamba` directly, hence the recommendation to install with `mamba env create` rather than `conda env create`.
+If you do not have `mamba` installed, you can still use `conda`... it will just be significantly slower.
+(To see what version of conda you have installed, run `conda --version`.)
 1. If `./manage_externals/checkout_externals` is not found, run `git submodule update --init` to clone the submodule.
 1. If `which cupid-run` returned the error `which: no cupid-run in ($PATH)`, then please run the following:
 

environments/README

@@ -0,0 +1,10 @@
+This directory contains three conda environment files:
+
+1. dev-environment.yml: this creates (cupid-dev), which provides cupid-run and cupid-build,
+                        and lets users update the main CUPiD code in cupid/
+
+2. cupid-analysis.yml: this creates (cupid-analysis), the environment all scripts and notebooks
+                       run in
+
+3. docs.yml: this creates (cupid-docs), which is used by github actions to build
+             https://ncar.github.io/CUPiD

environments/dev-environment.yml

@@ -0,0 +1,18 @@
+name: cupid-dev
+dependencies:
+    - python=3.11.4
+    - black
+    - dask
+    - dask-jobqueue
+    - intake
+    - intake-esm
+    - jinja2
+    - jupyter-book
+    - pandas
+    - papermill
+    - pip
+    - ploomber=0.22.3
+    - pyyaml
+    - xarray
+    - pip:
+      - -e ../