Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bcc2761 authored Feb 5, 2024
1 parent d64c991 commit 5d68ac9
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ FMS Runtime Environment (FRE) CLI developed using Python's Click package
- Create new Conda environment
- `conda create -n [environmentName]`
- Run `conda install` on needed dependencies
- `conda install noaa-gfdl::fre-cli` should install the CLI package created from the meta.yaml file located at https://anaconda.org/noaa-gfdl
- `conda install noaa-gfdl::fre-cli` should install the CLI package created from the meta.yaml file located at https://anaconda.org/NOAA-GFDL/fre-cli
- All other dependencies used by the tools are installed along with this install (configured inside the meta.yaml), with the exception of local modules
- setup.py file allows `fre.py` to be ran with `fre` as the entry point in the command line instead of `python fre.py`
* Enter commands and follow `--help` messages for guidance (brief rundown of commands also provided below)
Expand Down Expand Up @@ -60,3 +60,4 @@ To be developed:

* Currently, the solution to this task is to approach it using Conda packages. The tool that is being added must reside within a repository that contains a meta.yaml that includes Conda dependencies like the one in this repository and ideally a setup.py (may be subject to change due to deprecation) that may include any potentially needed pip dependencies
- Once published as a Conda package, ideally on the NOAA-GFDL channel at https://anaconda.org/NOAA-GFDL, an addition can be made to the "run" section under the "requirements" category in the meta.yaml of the fre-cli following the syntax `channel:package`
- On pushes to the main branch, the package located at https://anaconda.org/NOAA-GFDL/fre-cli will automatically be updated using the workflow file

0 comments on commit 5d68ac9

Please sign in to comment.