Merge pull request #297 from NOAA-GFDL/update-fre-version

Update FRE version for 2025 release
NOAA-GFDL · Dec 20, 2024 · e7bdec2 · e7bdec2
2 parents 5791010 + fa6d741
commit e7bdec2
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 13 deletions.
diff --git a/docs/setup.rst b/docs/setup.rst
@@ -1,14 +1,14 @@
 =====
 Setup
 =====
-fre-cli is conda-installable from the “noaa-gfdl” anaconda channel (https://anaconda.org/NOAA-GFDL/fre-cli)
+FRE-cli is conda-installable from the “noaa-gfdl” anaconda channel (https://anaconda.org/NOAA-GFDL/fre-cli)
 and is deployed on GFDL systems as Environment Modules.
 
 On GFDL systems
 ========================
 If you are at GFDL (gaea, PP/AN, workstations), you may skip installation::
 
-  module load fre/2024.01
+  module load fre/2025.01
 
   fre --help
 
@@ -26,7 +26,7 @@ Once you have conda available, install the latest fre-cli from the NOAA-GFDL ana
 
 To install a specific version::
 
-  conda create --name fre-202401 --channel noaa-gfdl --channel conda-forge fre-cli::2024.01
+  conda create --name fre-202501 --channel noaa-gfdl --channel conda-forge fre-cli::2025.01
 
 and activate it::
 

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -1,7 +1,7 @@
 =============
 Usage
 =============
-Using a set of YAML configuration files, ``fre make`` compiles a FMS-based model, and ``fre pp`` postprocesses the history output and runs diagnostic analysis scripts. Please note that model running is not yet supported in FRE 2024; continue to use FRE Bronx frerun.
+Using a set of YAML configuration files, ``fre make`` compiles a FMS-based model, and ``fre pp`` postprocesses the history output and runs diagnostic analysis scripts. Please note that model running is not yet supported in FRE 2025; continue to use FRE Bronx frerun.
 
 YAML Framework
 ========================

diff --git a/docs/usage/yaml_framework.rst b/docs/usage/yaml_framework.rst
@@ -1,4 +1,4 @@
-In order to utilize FRE 2024.01 tools, a distrubuted YAML structure is required. This framework includes a main model yaml, a compile yaml, a platforms yaml, and post-processing yamls. Throughout the compilation and post-processing steps, combined yamls that will be parsed for information are created. Yamls follow a dictionary-like structure with ``[key]: [value]`` fields. 
+In order to utilize these FRE tools, a distrubuted YAML structure is required. This framework includes a main model yaml, a compile yaml, a platforms yaml, and post-processing yamls. Throughout the compilation and post-processing steps, combined yamls that will be parsed for information are created. Yamls follow a dictionary-like structure with ``[key]: [value]`` fields. 
 
 Yaml Formatting
 ----------
@@ -53,14 +53,15 @@ Where each dash indicates a list.
 
   *ReusableVariable
 
-7. If the reusable variable must be combined with other strings, the **`!join`** constructor is used. Example: 
+7. If the reusable variable must be combined with other strings, the **`!join`** constructor is used. Simplified example: 
 
 .. code-block:: 
 
-  &version "2024.01"
-  &stem !join [FRE/, *version]
+  &name "experiment-name"
+  ...
+  pp_dir: !join [/archive/$USER/, *name, /, pp]
 
-In this example, the reuasble variable ``stem`` will be parsed as ``FRE/2024.01``.
+In this example, the variable ``pp_dir`` will be parsed as ``/archive/$USER/experiment-name/pp``.
 
 Model Yaml
 ----------

diff --git a/docs/what-is-fre.rst b/docs/what-is-fre.rst
@@ -4,7 +4,7 @@ What is FRE?
 
 FRE, the FMS Runtime Environment, is the companion runtime workflow for FMS-based climate and earth system models, and contains scripts and batch job handlers to compile models, run experiments, and postprocess and analyze the output. Developed around 2004 by GFDL's Modeling System Division, FRE was developed primarily in one repository ("fre-commands", https://github.com/NOAA-GFDL/FRE), used subtools in another repository (FRE-NCtools, https://github.com/NOAA-GFDL/fre-nctools), and was deployed using a set of Environment Modules (https://gitlab.gfdl.noaa.gov/fre/modulefiles). Originally, the major releases of FRE were rivers (Arkansas, Bronx) and the minor releases were numbers. In practice, though, the "Bronx" release name was retained and the number has been incremented over the years. e.g. Bronx-23 is the latest release.
 
-Over the last couple years, MSD's workflow team has reengineered the compiling and postprocessing parts of FRE, in a modern python and Cylc-based ecosystem (running experiments is not yet possible with this new FRE; stay tuned). Following a semantic versioning adopted in other FMS repositories, the reengineered FRE is versioned with a year and incrementing two-digit number. e.g. the first release of 2024 is 2024.01, the second 2024.02, and the first release next year will be 2025.01. (Optional minor releases are also available in the scheme; e.g. 2024.01.01 would be the first minor/patch release after 2024.01.) This version is used as tags in FRE repositories and in the corresponding conda (and in the future, container) release, and can be retrieved from ``fre --version``.
+Over the last couple years, MSD's workflow team has reengineered the compiling and postprocessing parts of FRE, in a modern python and Cylc-based ecosystem (running experiments is not yet possible with this new FRE; stay tuned). Following a semantic versioning adopted in other FMS repositories, the reengineered FRE is versioned with a year and incrementing two-digit number. e.g. the first release of 2025 is 2025.01, the second 2025.02, etc. (Optional minor releases are also available in the scheme; e.g. 2025.01.01 would be the first minor/patch release after 2025.01.) This version is used as tags in FRE repositories and in the corresponding conda (and in the future, container) release, and can be retrieved from ``fre --version``.
 
 fre-cli (this repository) can be considered a successor to the FRE Bronx “fre-commands” repository, which primarily contains user-facing tools and subtools. fre-workflows (https://github.com/NOAA-GFDL/fre-workflows) is a companion repository containing workflow definitions that can be run by the Cylc workflow engine. It contains workflow-specific elements previously in FRE Bronx, and allows flexibility to support multiple and more complex workflows. The two new FRE repositories are versioned with the same approach, and updates will be released together for some time to ensure compatibility.
 

diff --git a/fre/tests/test_fre_cli.py b/fre/tests/test_fre_cli.py
@@ -24,11 +24,11 @@ def test_cli_fre_option_dne():
 
 def test_fre_version():
     ''' module import flavor of below cli test '''
-    assert '2024.01' == fre.version
+    assert '2025.01' == fre.version
 
 def test_cli_fre_version():
     ''' fre --version '''
     result = runner.invoke(fre.fre, args='--version')
-    expected_out = 'fre, version 2024.01'
+    expected_out = 'fre, version 2025.01'
     assert all( [ result.exit_code == 0,
                   expected_out in result.stdout.split('\n') ] )
diff --git a/setup.py b/setup.py
@@ -2,7 +2,7 @@
 
 setup(
     name='fre-cli',
-    version='2024.01',
+    version='2025.01',
     description='Command Line Interface for FRE commands',
     author='MSD Workflow Team, Bennett Chang, Dana Singh, Chris Blanton',
     author_email='[email protected]',