From 4919ec2bf0a3586084c6976bbf71e4eacf17ee8e Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:19:13 +0000 Subject: [PATCH 1/6] Initial plan From a8187182a5abd4d2266c4c4397c615043033c93f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:21:10 +0000 Subject: [PATCH 2/6] Add comprehensive documentation for PR #707 dependency changes Co-authored-by: ilaflott <6273252+ilaflott@users.noreply.github.com> --- CONTRIBUTING.md | 31 +++++++++ README.md | 24 +++++++ docs/DEPENDENCIES.md | 126 ++++++++++++++++++++++++++++++++++++ fre/app/regrid_xy/README.md | 31 ++++++++- 4 files changed, 211 insertions(+), 1 deletion(-) create mode 100644 docs/DEPENDENCIES.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7cccb8f1e..188e82463 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,37 @@ - Test as a normal user would use the CLI * Create a GitHub issue to reflect your contribution's background and reference it with Git commits +### **Development Environment Setup** + +#### Python Version Support +`fre-cli` supports Python >= 3.11. The package is currently tested and developed on Python 3.12. When setting up your development environment, ensure you use a compatible Python version. + +#### External Dependencies +Some functionality requires external tools not included in the conda package dependencies: + +- **fregrid** (from fre-nctools): Required for `fre app regrid_xy` operations + - Must be loaded separately via module or environment + - Tests for this functionality will be automatically skipped if `fregrid` is not in your PATH + - Use `which fregrid` to check availability + +**Testing with Optional Dependencies:** +When running tests, you may see some tests skipped with messages like: +``` +SKIPPED [1] fre/app/regrid_xy/tests/test_regrid_xy.py:85: fregrid not in env. it was removed from package reqs. you must load it externally +``` + +This is expected behavior when optional dependencies are not available. To run all tests: +```bash +# On GFDL/Gaea systems +module load fre-nctools +pytest +``` + +#### Key Dependency Versions +- CMOR >= 3.14 (latest PCMDI/cmor features) +- numpy == 1.26.4 (pinned for stability) +- netcdf4 >= 1.7.* + ### **Opening Pull Requests and Issues** Please use one of the templates present in this repository to open a PR or an issue, and fill out the template to the best of your ability. diff --git a/README.md b/README.md index cd95effc8..8708a417a 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,30 @@ means, read the graphic below: ![Screenshot from 2024-04-18 13-42-04](https://github.com/NOAA-GFDL/fre-cli/assets/98476720/43c028a6-4e6a-42fe-8bec-008b6758ea9b) +## **Requirements** + +`fre-cli` requires: +- **Python** >= 3.11 (currently tested and developed on Python 3.12) +- **CMOR** >= 3.14 (upgraded from 3.11 for latest PCMDI/cmor features) + +### Optional External Dependencies + +Some `fre` subtools require external dependencies that are **not** included in the conda package: + +- **fregrid** (from fre-nctools): Required for `fre app regrid_xy` operations + - Must be loaded separately via module system or installed independently + - Tests for regrid_xy functionality will be automatically skipped if not available + +**On GFDL/Gaea systems:** +```bash +module load fre-nctools +``` + +**Or install separately:** +```bash +conda install -c noaa-gfdl fre-nctools +``` + ## **Quickstart** `fre-cli` is conda-installable from the “noaa-gfdl” anaconda channel (https://anaconda.org/NOAA-GFDL/fre-cli) and is diff --git a/docs/DEPENDENCIES.md b/docs/DEPENDENCIES.md new file mode 100644 index 000000000..d1fc2203a --- /dev/null +++ b/docs/DEPENDENCIES.md @@ -0,0 +1,126 @@ +# fre-cli Dependencies Reference + +This document describes the dependencies required for `fre-cli` and provides guidance on version requirements and optional dependencies. + +## Core Dependencies + +### Python +- **Requirement:** >= 3.11 +- **Tested versions:** 3.11, 3.12 +- **Notes:** As of the 2025.04 release cycle, Python 3.11 and 3.12 are officially supported + +### CMOR (Climate Model Output Rewriter) +- **Requirement:** >= 3.14 +- **Channel:** conda-forge +- **Notes:** Upgraded from 3.11 to access latest features from PCMDI/cmor. See PCMDI/cmor releases for details + +### Core Python Packages +- **click** >= 8.2 +- **numpy** == 1.26.4 (pinned for stability) +- **netcdf4** >= 1.7.* +- **xarray** >= 2024.* +- **pyyaml** +- **cftime** +- **jinja2** >= 3 + +### Build Dependencies +- **python** >= 3.11 +- **pip** +- **setuptools** +- **wheel** + +## Optional External Dependencies + +### fre-nctools (fregrid) +**Required for:** `fre app regrid_xy` + +`fregrid` is **no longer bundled** as a package dependency. It must be loaded separately. + +**Installation options:** + +1. **On GFDL/Gaea systems** (recommended): + ```bash + module load fre-nctools + ``` + +2. **Via conda:** + ```bash + conda install -c noaa-gfdl fre-nctools + ``` + +**Testing behavior:** +- Tests requiring fregrid will be automatically skipped if not available +- Skip message: `"fregrid not in env. it was removed from package reqs. you must load it externally"` + +**Verification:** +```bash +which fregrid +``` + +## Workflow-Specific Dependencies + +### Cylc/Rose Workflows +- **cylc-flow** >= 8.2 +- **cylc-rose** +- **metomi-rose** + +### Post-Processing +- **CDO** (Climate Data Operators) >= 2 +- **nccmp** (for netCDF comparison) +- **python-cdo** + +### Analysis +- **analysis_scripts** == 0.0.1 (noaa-gfdl channel) + +### Cataloging +- **catalogbuilder** == 2025.01.01 (noaa-gfdl channel) + +## Development Dependencies + +### Testing +- **pytest** +- **pytest-cov** + +### Code Quality +- **pylint** + +## Migration Notes + +### Upgrading from Previous Versions + +**If upgrading from versions with Python 3.11.*** +- Python >= 3.11 is now supported (not pinned to 3.11.*) +- You can use Python 3.12 or later 3.11.x versions + +**If upgrading from versions with CMOR 3.11:** +- CMOR >= 3.14 is now required +- Update your environment: `conda update cmor` + +**If you use `fre app regrid_xy`:** +- `fregrid` is no longer automatically available +- Load fre-nctools separately before using regrid_xy +- Add `module load fre-nctools` to your workflow scripts + +## Troubleshooting + +### "fregrid: command not found" +**Cause:** fregrid is not in your PATH +**Solution:** Load fre-nctools module or install it separately (see above) + +### CMOR version errors +**Cause:** CMOR version < 3.14 +**Solution:** Update CMOR: `conda update -c conda-forge cmor` + +### Python version incompatibility +**Cause:** Python version < 3.11 +**Solution:** Create new environment with Python >= 3.11: +```bash +conda create -n fre-cli-env python=3.12 +conda activate fre-cli-env +conda install -c noaa-gfdl fre-cli +``` + +## References +- PCMDI/cmor +- NOAA-GFDL conda channel +- fre-cli documentation diff --git a/fre/app/regrid_xy/README.md b/fre/app/regrid_xy/README.md index 80964521e..5f604f021 100644 --- a/fre/app/regrid_xy/README.md +++ b/fre/app/regrid_xy/README.md @@ -2,7 +2,36 @@ `regrid_xy.py` remaps scalar and/or vector fields from one kind of lat/lon grid to another. It can remap between different grids of the same type (e.g. spherical), and between grids of different types (e.g. spherical to tripolar). By default, it uses an O(1) conservative interpolation scheme to accomplish the regridding, except under certain conditions [defined within `fregrid`](https://github.com/NOAA-GFDL/FRE-NCtools/blob/master/tools/fregrid/fregrid.c#L915-L920) the underlying CLI tool which does the heavy lifting. -requires `fre-nctools` and `fregrid` to be in one's `PATH` variable, and `python3` (tested/developed with python 3.9.16). there should be `netCDF4` and `metomi` python modules in one's python environment for imports. `pytest` and `nccmp` is required for tests. `pylint` recommended for future developers working on this tool. +## Prerequisites + +**Important:** As of fre-cli version 2025.04+, `fregrid` from `fre-nctools` is **no longer bundled** as a package dependency and must be available in your environment separately. + +### Required in PATH +- **fregrid** - Must be loaded externally from fre-nctools + + To check if fregrid is available: + ```bash + which fregrid + ``` + + If not available, on GFDL/Gaea systems: + ```bash + module load fre-nctools + ``` + + Or install separately: + ```bash + conda install -c noaa-gfdl fre-nctools + ``` + +### Python Requirements +- Python >= 3.11 (tested/developed with Python 3.12) +- `netCDF4` python module +- `xarray` python module +- `pytest` and `nccmp` for running tests +- `pylint` recommended for developers + +**Note:** Without `fregrid` in your PATH, regrid_xy operations will fail, and related tests will be automatically skipped. # INPUT PARAMETERS (mandatory, env vars) From efe3b6d9f792ee8feedbaa44f945328916c64f4e Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:31:38 +0000 Subject: [PATCH 3/6] Update regrid_xy README: Python >=3.11, fregrid no longer bundled Co-authored-by: ilaflott <6273252+ilaflott@users.noreply.github.com> --- CONTRIBUTING.md | 31 --------- README.md | 24 ------- docs/DEPENDENCIES.md | 126 ------------------------------------ fre/app/regrid_xy/README.md | 31 +-------- 4 files changed, 1 insertion(+), 211 deletions(-) delete mode 100644 docs/DEPENDENCIES.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 188e82463..7cccb8f1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,37 +6,6 @@ - Test as a normal user would use the CLI * Create a GitHub issue to reflect your contribution's background and reference it with Git commits -### **Development Environment Setup** - -#### Python Version Support -`fre-cli` supports Python >= 3.11. The package is currently tested and developed on Python 3.12. When setting up your development environment, ensure you use a compatible Python version. - -#### External Dependencies -Some functionality requires external tools not included in the conda package dependencies: - -- **fregrid** (from fre-nctools): Required for `fre app regrid_xy` operations - - Must be loaded separately via module or environment - - Tests for this functionality will be automatically skipped if `fregrid` is not in your PATH - - Use `which fregrid` to check availability - -**Testing with Optional Dependencies:** -When running tests, you may see some tests skipped with messages like: -``` -SKIPPED [1] fre/app/regrid_xy/tests/test_regrid_xy.py:85: fregrid not in env. it was removed from package reqs. you must load it externally -``` - -This is expected behavior when optional dependencies are not available. To run all tests: -```bash -# On GFDL/Gaea systems -module load fre-nctools -pytest -``` - -#### Key Dependency Versions -- CMOR >= 3.14 (latest PCMDI/cmor features) -- numpy == 1.26.4 (pinned for stability) -- netcdf4 >= 1.7.* - ### **Opening Pull Requests and Issues** Please use one of the templates present in this repository to open a PR or an issue, and fill out the template to the best of your ability. diff --git a/README.md b/README.md index 8708a417a..cd95effc8 100644 --- a/README.md +++ b/README.md @@ -27,30 +27,6 @@ means, read the graphic below: ![Screenshot from 2024-04-18 13-42-04](https://github.com/NOAA-GFDL/fre-cli/assets/98476720/43c028a6-4e6a-42fe-8bec-008b6758ea9b) -## **Requirements** - -`fre-cli` requires: -- **Python** >= 3.11 (currently tested and developed on Python 3.12) -- **CMOR** >= 3.14 (upgraded from 3.11 for latest PCMDI/cmor features) - -### Optional External Dependencies - -Some `fre` subtools require external dependencies that are **not** included in the conda package: - -- **fregrid** (from fre-nctools): Required for `fre app regrid_xy` operations - - Must be loaded separately via module system or installed independently - - Tests for regrid_xy functionality will be automatically skipped if not available - -**On GFDL/Gaea systems:** -```bash -module load fre-nctools -``` - -**Or install separately:** -```bash -conda install -c noaa-gfdl fre-nctools -``` - ## **Quickstart** `fre-cli` is conda-installable from the “noaa-gfdl” anaconda channel (https://anaconda.org/NOAA-GFDL/fre-cli) and is diff --git a/docs/DEPENDENCIES.md b/docs/DEPENDENCIES.md deleted file mode 100644 index d1fc2203a..000000000 --- a/docs/DEPENDENCIES.md +++ /dev/null @@ -1,126 +0,0 @@ -# fre-cli Dependencies Reference - -This document describes the dependencies required for `fre-cli` and provides guidance on version requirements and optional dependencies. - -## Core Dependencies - -### Python -- **Requirement:** >= 3.11 -- **Tested versions:** 3.11, 3.12 -- **Notes:** As of the 2025.04 release cycle, Python 3.11 and 3.12 are officially supported - -### CMOR (Climate Model Output Rewriter) -- **Requirement:** >= 3.14 -- **Channel:** conda-forge -- **Notes:** Upgraded from 3.11 to access latest features from PCMDI/cmor. See PCMDI/cmor releases for details - -### Core Python Packages -- **click** >= 8.2 -- **numpy** == 1.26.4 (pinned for stability) -- **netcdf4** >= 1.7.* -- **xarray** >= 2024.* -- **pyyaml** -- **cftime** -- **jinja2** >= 3 - -### Build Dependencies -- **python** >= 3.11 -- **pip** -- **setuptools** -- **wheel** - -## Optional External Dependencies - -### fre-nctools (fregrid) -**Required for:** `fre app regrid_xy` - -`fregrid` is **no longer bundled** as a package dependency. It must be loaded separately. - -**Installation options:** - -1. **On GFDL/Gaea systems** (recommended): - ```bash - module load fre-nctools - ``` - -2. **Via conda:** - ```bash - conda install -c noaa-gfdl fre-nctools - ``` - -**Testing behavior:** -- Tests requiring fregrid will be automatically skipped if not available -- Skip message: `"fregrid not in env. it was removed from package reqs. you must load it externally"` - -**Verification:** -```bash -which fregrid -``` - -## Workflow-Specific Dependencies - -### Cylc/Rose Workflows -- **cylc-flow** >= 8.2 -- **cylc-rose** -- **metomi-rose** - -### Post-Processing -- **CDO** (Climate Data Operators) >= 2 -- **nccmp** (for netCDF comparison) -- **python-cdo** - -### Analysis -- **analysis_scripts** == 0.0.1 (noaa-gfdl channel) - -### Cataloging -- **catalogbuilder** == 2025.01.01 (noaa-gfdl channel) - -## Development Dependencies - -### Testing -- **pytest** -- **pytest-cov** - -### Code Quality -- **pylint** - -## Migration Notes - -### Upgrading from Previous Versions - -**If upgrading from versions with Python 3.11.*** -- Python >= 3.11 is now supported (not pinned to 3.11.*) -- You can use Python 3.12 or later 3.11.x versions - -**If upgrading from versions with CMOR 3.11:** -- CMOR >= 3.14 is now required -- Update your environment: `conda update cmor` - -**If you use `fre app regrid_xy`:** -- `fregrid` is no longer automatically available -- Load fre-nctools separately before using regrid_xy -- Add `module load fre-nctools` to your workflow scripts - -## Troubleshooting - -### "fregrid: command not found" -**Cause:** fregrid is not in your PATH -**Solution:** Load fre-nctools module or install it separately (see above) - -### CMOR version errors -**Cause:** CMOR version < 3.14 -**Solution:** Update CMOR: `conda update -c conda-forge cmor` - -### Python version incompatibility -**Cause:** Python version < 3.11 -**Solution:** Create new environment with Python >= 3.11: -```bash -conda create -n fre-cli-env python=3.12 -conda activate fre-cli-env -conda install -c noaa-gfdl fre-cli -``` - -## References -- PCMDI/cmor -- NOAA-GFDL conda channel -- fre-cli documentation diff --git a/fre/app/regrid_xy/README.md b/fre/app/regrid_xy/README.md index 5f604f021..2d04660d9 100644 --- a/fre/app/regrid_xy/README.md +++ b/fre/app/regrid_xy/README.md @@ -2,36 +2,7 @@ `regrid_xy.py` remaps scalar and/or vector fields from one kind of lat/lon grid to another. It can remap between different grids of the same type (e.g. spherical), and between grids of different types (e.g. spherical to tripolar). By default, it uses an O(1) conservative interpolation scheme to accomplish the regridding, except under certain conditions [defined within `fregrid`](https://github.com/NOAA-GFDL/FRE-NCtools/blob/master/tools/fregrid/fregrid.c#L915-L920) the underlying CLI tool which does the heavy lifting. -## Prerequisites - -**Important:** As of fre-cli version 2025.04+, `fregrid` from `fre-nctools` is **no longer bundled** as a package dependency and must be available in your environment separately. - -### Required in PATH -- **fregrid** - Must be loaded externally from fre-nctools - - To check if fregrid is available: - ```bash - which fregrid - ``` - - If not available, on GFDL/Gaea systems: - ```bash - module load fre-nctools - ``` - - Or install separately: - ```bash - conda install -c noaa-gfdl fre-nctools - ``` - -### Python Requirements -- Python >= 3.11 (tested/developed with Python 3.12) -- `netCDF4` python module -- `xarray` python module -- `pytest` and `nccmp` for running tests -- `pylint` recommended for developers - -**Note:** Without `fregrid` in your PATH, regrid_xy operations will fail, and related tests will be automatically skipped. +requires `fregrid` to be in one's `PATH` variable (`fre-nctools` no longer bundled; load via `module load fre-nctools`), and `python3` >= 3.11 (tested/developed with python 3.12). there should be `netCDF4` and `xarray` python modules in one's python environment for imports. `pytest` and `nccmp` is required for tests. `pylint` recommended for future developers working on this tool. # INPUT PARAMETERS (mandatory, env vars) From cb96f5c519a498f5b5e9715145386bcb5dc2e6fe Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:41:13 +0000 Subject: [PATCH 4/6] Add optional fre-nctools loading instructions to setup sections Co-authored-by: ilaflott <6273252+ilaflott@users.noreply.github.com> --- CONTRIBUTING.md | 1 + README.md | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7cccb8f1e..8cc56bc31 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,7 @@ * Developers are free to use this repository's `README.md` to familiarize with the CLI and save time from having to install any dependencies, but development within a Conda environment is heavily recommended regardless * Gain access to the repository with `git clone --recursive git@github.com:NOAA-GFDL/fre-cli.git` or your fork's link (recommended) and an SSH RSA key - Once inside the repository, developers can test local changes by running a `pip install .` inside of the root directory to install the fre-cli package locally with the newest local changes on top of the installed Conda fre-cli dependencies + - Optional: load fre-nctools into your PATH to gain access to regridding and certain time-averaging routines (e.g., `module load fre-nctools` on GFDL/Gaea systems) - Test as a normal user would use the CLI * Create a GitHub issue to reflect your contribution's background and reference it with Git commits diff --git a/README.md b/README.md index cd95effc8..76c35bc25 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ loading fre-cli into a user's environment. ``` module use -a /ncrc/home2/fms/local/modulefiles module load fre/2025.04 +# optional: load fre-nctools into your PATH to gain access to regridding and certain time-averaging routines +# module load fre-nctools ``` #### Activate a shared conda environment: @@ -50,11 +52,15 @@ module load fre/2025.04 ``` module load miniforge conda activate /nbhome/fms/conda/envs/fre-2025.04 +# optional: load fre-nctools into your PATH to gain access to regridding and certain time-averaging routines +# module load fre-nctools ``` - Gaea: ``` module use /usw/conda/modulefiles module load miniforge conda activate /ncrc/home2/fms/.conda/envs/fre-2025.04 +# optional: load fre-nctools into your PATH to gain access to regridding and certain time-averaging routines +# module load fre-nctools ``` ## Install via Conda @@ -67,6 +73,8 @@ conda config --append channels noaa-gfdl conda config --append channels conda-forge conda create --name fre-2025.04 --channel noaa-gfdl --channel conda-forge fre-cli::2025.04 conda activate fre-2025.04 +# optional: install fre-nctools to gain access to regridding and certain time-averaging routines +# conda install -c noaa-gfdl fre-nctools ``` ## GFDL/RDHPCS deployment notes From 2f0dca1052b182feacaf73c9306159d610e2adb8 Mon Sep 17 00:00:00 2001 From: "Ian L." <6273252+ilaflott@users.noreply.github.com> Date: Fri, 30 Jan 2026 14:52:22 -0500 Subject: [PATCH 5/6] Revise fre-nctools loading instructions in README Updated instructions for loading fre-nctools and added notes on installation options. --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 76c35bc25..c0cc7c4f6 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,6 @@ loading fre-cli into a user's environment. ``` module use -a /ncrc/home2/fms/local/modulefiles module load fre/2025.04 -# optional: load fre-nctools into your PATH to gain access to regridding and certain time-averaging routines -# module load fre-nctools ``` #### Activate a shared conda environment: @@ -52,15 +50,11 @@ module load fre/2025.04 ``` module load miniforge conda activate /nbhome/fms/conda/envs/fre-2025.04 -# optional: load fre-nctools into your PATH to gain access to regridding and certain time-averaging routines -# module load fre-nctools ``` - Gaea: ``` module use /usw/conda/modulefiles module load miniforge conda activate /ncrc/home2/fms/.conda/envs/fre-2025.04 -# optional: load fre-nctools into your PATH to gain access to regridding and certain time-averaging routines -# module load fre-nctools ``` ## Install via Conda @@ -73,8 +67,11 @@ conda config --append channels noaa-gfdl conda config --append channels conda-forge conda create --name fre-2025.04 --channel noaa-gfdl --channel conda-forge fre-cli::2025.04 conda activate fre-2025.04 -# optional: install fre-nctools to gain access to regridding and certain time-averaging routines -# conda install -c noaa-gfdl fre-nctools +# optional: install or load fre-nctools to gain access to regridding and certain time-averaging routines +# add to your path like: export PATH=/path/to/your/fre-nctools/build/bin:$PATH +# or if you have lmod/modules: module load fre-nctools/ +# or compile/install from source: see github.comNOAA-GDFL/FRE-NCTools documentation on compilation/installation +# DO NOT USE noaa-gfdl::fre-nctools==2022.01 at this time, it is being deprecated ``` ## GFDL/RDHPCS deployment notes From 55aec316dd25250f08bb0499e19f36795cfb675c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 30 Jan 2026 19:57:01 +0000 Subject: [PATCH 6/6] Add optional fre-nctools loading instructions to docs/ setup sections Co-authored-by: ilaflott <6273252+ilaflott@users.noreply.github.com> --- docs/contributing_to_doc.rst | 3 +++ docs/setup.rst | 3 +++ 2 files changed, 6 insertions(+) diff --git a/docs/contributing_to_doc.rst b/docs/contributing_to_doc.rst index ea1924979..f343413e4 100644 --- a/docs/contributing_to_doc.rst +++ b/docs/contributing_to_doc.rst @@ -90,6 +90,9 @@ From the root-directory of your local repository copy: # Activate your fre-cli environment conda activate fre-cli + # optional: load fre-nctools into your PATH to gain access to regridding and certain time-averaging routines + # module load fre-nctools + # Install documentation dependencies pip install .[docs] diff --git a/docs/setup.rst b/docs/setup.rst index cc5721d41..55746b776 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -42,3 +42,6 @@ Assuming one has ``conda`` in their path, then do the following:: # now we pip install the local code under the `fre/` directory # the -e flag makes re-installing the code after editing not necessary pip install -e . + + # optional: load fre-nctools into your PATH to gain access to regridding and certain time-averaging routines + # module load fre-nctools