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..c0cc7c4f6 100644 --- a/README.md +++ b/README.md @@ -67,6 +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 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 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 diff --git a/fre/app/regrid_xy/README.md b/fre/app/regrid_xy/README.md index 80964521e..2d04660d9 100644 --- a/fre/app/regrid_xy/README.md +++ b/fre/app/regrid_xy/README.md @@ -2,7 +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. -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. +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)