Clean up env files

Author: iamzoltan

.github/actions/setup-python-env/action.yaml

@@ -20,7 +20,7 @@ runs:
       uses: mamba-org/setup-micromamba@v3
       with:
         micromamba-version: 'latest'
-        environment-file: ci-environment.yml
+        environment-file: environment.yml
         init-shell: bash
         cache-downloads: true
         cache-environment: true

.github/workflows/notebook-pr.yaml

@@ -11,8 +11,7 @@ on:
       - .github/actions/setup-python-env/action.yaml
       - .github/actions/setup-ci-tools/action.yaml
       - .github/actions/setup-rendering-deps/action.yaml
-      - 'ci-environment.yml'
-      - '**/requirements.txt'
+      - 'environment.yml'
 
 env:
   NB_KERNEL: python

Contributing.md

@@ -6,7 +6,26 @@ The Course is built off from the `main` branch of this repo. The `main` branch i
 1. Have a Github accounts and request @WesleyTheGeolien to add you to [ClimateMatchAcademy](https://github.com/orgs/ClimateMatchAcademy/teams) and [Content Creators](https://github.com/orgs/ClimateMatchAcademy/teams/content-creators)
 1. Have git (a version control system) installed locally, see documnetation [here](https://github.com/git-guides/install-git), if you are not familiar with using a terminal I would recommend installing the Github Desktop Client
 1. (Optional) Install [VS Code](https://code.visualstudio.com/download) which is your "development environment", it also intergrates nicely with Version Control (git)
-1. (Option) Install [miniconda](https://docs.conda.io/en/latest/miniconda.html) or [Anaconda Navigtor](https://docs.anaconda.com/free/navigator/) This is used to create virtual environments and execute your notebooks.
+1. (Optional) Install [miniforge](https://github.com/conda-forge/miniforge) to run notebooks locally. This is used to create virtual environments and execute your notebooks.
+
+## Running Notebooks Locally
+
+To run tutorial notebooks on your own machine:
+
+1. Install [miniforge](https://github.com/conda-forge/miniforge) if you haven't already
+1. Clone the repo and create the conda environment:
+   ```bash
+   git clone https://github.com/neuromatch/climate-course-content.git
+   cd climate-course-content
+   conda env create -f environment.yml
+   conda activate climatematch
+   ```
+1. Launch Jupyter and open any tutorial notebook:
+   ```bash
+   jupyter lab
+   ```
+
+The `environment.yml` at the repo root contains all packages needed to run every tutorial.
 
 ## Updating Tutorial Notebooks
 

ci-environment.yml

@@ -3,132 +3,62 @@ channels:
  - conda-forge
  - nodefaults
 dependencies:
- # - python=3.9
- - adlfs
- - argopy
- - awscli
  - boto3
- - bottleneck
  - cartopy
  - cdsapi
  - cfgrib
- - ciso  # no build for osx-arm64
  - climlab
+ - climlab-rrtmg
  - cmocean
- - dask-ml
- - datashader
- - descartes
- - earthaccess
- - ecco_v4_py  # no build for osx-arm64
-#  - eigen # needed for SDFC
  - eofs
- - erddapy
  - esmf
  - esmpy
- - fastjmd95
  - flox
  - fsspec
- - gcm_filters
  - gcsfs
- - gh
- - geocube
  - geopandas
- - geopy
  - geoviews-core
- - gh-scoped-creds
- - git
- - git-lfs
  - gsw
  - h5netcdf
  - h5py
  - holoviews
- - hvplot
  - intake
  - intake-esm
- - intake-geopandas
- - intake-stac
  - intake-xarray
  - ipykernel>=6.21.2
- - ipyleaflet
- - ipytree
  - ipywidgets
- - jupyter-panel-proxy
- - jupyter-resource-usage
- - jupyterlab-git
- - kerchunk
- - lxml
- - lz4
  - matplotlib-base
  - metpy
- - nb_conda_kernels
- - nbstripout
  - nc-time-axis
  - netcdf4
  - nltk
- - numcodecs
  - numpy
- - odc-stac
  - openpyxl
  - pandas
  - panel
- - parcels
- - param
  - pip
  - plotly
  - pooch
- - pop-tools
- - pyarrow
-#  - pybind11 # needed for SDFC
- - pycamhd
- - pydap
- - pygeos
- - pystac
- - pystac-client
  - pythia-datasets
- - python-blosc
- - python-gist
  - python-graphviz
  - pytorch
- - pyworld3 # needed for W2D3
- - rasterio
- - rechunker
- - rio-cogeo
- - rioxarray
+ - pyworld3
  - s3fs
- - satpy
- - scikit-image
  - scikit-learn
- - scipy<=1.11.4 # for pyleoclim
+ - scipy
  - seaborn
- - sparse
- - snakeviz
- - stackstac
  - texttable
- - tiledb-py
- - timezonefinder
  - torchvision
  - wordcloud
  - xarray==2024.2.0
- - xarrayutils
  - xarray-datatree
- - xarray_leaflet
- - xarray-spatial
- - xbatcher
- - xclim
  - xesmf
- - xgcm
- - xhistogram
  - xmip
- - xmitgcm
- - xpublish
- - xrft
- - xskillscore
  - zarr
  - pip:
    - afinn
    - lipd
    - pyleoclim
    - "mystatsfunctions @ https://github.com/njleach/mystatsfunctions/archive/main.zip"
-#   - "SDFC @ https://github.com/yrobink/SDFC/archive/master.zip" # this is not working
-#   -  https://github.com/mptouzel/PyDICE/archive/master.zip # for W2D3 Tutorial 2
+   - "dicelib @ https://github.com/mptouzel/PyDICE/archive/master.zip"