From 2e0d0f1053bde0d4883b3fa42604106a8053926d Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Fri, 9 Aug 2024 16:13:27 -0600 Subject: [PATCH] Feature 48 release 2.0 (#49) * Updated version number and date * Per #48, updating release notes * Per 8, adding information for this release's download * Per #48, adding two new publications * Per #48, changing format of entry * Per #48, fixed the formatting --- docs/conf.py | 4 ++-- docs/downloads.rst | 6 +++++- docs/publications.rst | 13 +++++++++++++ docs/release_notes.rst | 41 +++++++++++++++++++++++++++++++---------- 4 files changed, 51 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1abbebb..34ec63f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,11 +22,11 @@ project = 'FastEddy' author = 'UCAR/NCAR' author_list = 'Sauer, J., D. Muñoz-Esparza' -version = '1.1.0' +version = '2.0' verinfo = version release = f'{version}' release_year = '2024' -release_date = f'{release_year}-04-22' +release_date = f'{release_year}-08-09' copyright = f'{release_year}, {author}' # -- General configuration --------------------------------------------------- diff --git a/docs/downloads.rst b/docs/downloads.rst index 7b5557f..e5142f5 100644 --- a/docs/downloads.rst +++ b/docs/downloads.rst @@ -9,7 +9,11 @@ Downloads * - Version - Release Date - Tar File - - Release Notes + - Release Notes + * - 2.0.0 + - August 9, 2024 + - `v2.0.0.tar.gz `_ + - `v2.0.0 Release Notes `_ * - 1.1.0 - April 22, 2024 - `v1.1.0.tar.gz `_ diff --git a/docs/publications.rst b/docs/publications.rst index 14f3cb2..79aa6b8 100644 --- a/docs/publications.rst +++ b/docs/publications.rst @@ -4,6 +4,19 @@ Publications ************ +.. _wind_energy_2024: + +| Sanchez Gomez, M., D. Muñoz-Esparza, J.A. Sauer. "Implementation and Validation +| of a Generalized Actuator Disk Parameterization for Wind Turbine Simulations +| Within the FastEddy Model". *Wind Energy* (2024) +| http://doi.org/10.1002/we.2941 + +.. _atmosphere_2024: + +| Welch, B.M.; Horel, J.D.; Sauer, J.A. "Application of the NCAR FastEddy\ :sup:`®` +| Microscale Model to a Lake Breeze Front". *Atmosphere* 15, no.7 (2024) 809 +| https://doi.org/10.3390/atmos15070809 + .. _geophysical_research_2022: | Muñoz-Esparza, D., C. Becker, J.A. Sauer, D.J. Gagne II, J. Schreck, B. Kosović. diff --git a/docs/release_notes.rst b/docs/release_notes.rst index a772b95..9e3754c 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -2,10 +2,31 @@ Release Notes ************* -When applicable, release notes are followed by the GitHub issue number which -describes the bugfix, enhancement, or new feature -(`FastEddy-model GitHub issues `_). +FastEddy-model Version 2.0 Release Notes (20240809) +=================================================== + +.. dropdown:: Repository, build, and test + + * Three new tutorials (canopy, offshore, passive scalar transport and dispersion) + * Demonstration of including terrain and N-ranks to N-files raw binary output and post-processing to single NetCDF via Python + * Runtime parameter checks provide guidance for inter/intra-device parallelization settings + +.. dropdown:: Bugfixes + + * Linear interpolation of pressure bottom/top boundary conditions instead of constant + * Small fix to the forcing term for condensation + +.. dropdown:: Enhancements + + * Additional explicit filters (divergence damping and horizontal 6th-order diffusion) [Contributed by Prof. Bowen Zhou from Nanjing University, China] + * Two-equation canopy model + * A suite of offshore roughness parameterizations + * A dynamic formulation for thermal roughness length over land + * Auxiliary passive scalar transport and dispersion + * Additional documentation content (building, running on NSF NCAR HPC, publications, downloads, and more) + + FastEddy-model Version 1.1 Release Notes (20240422) =================================================== @@ -19,18 +40,18 @@ Casper and Derecho platforms, along with other changes as detailed below: .. dropdown:: Repository, build, and test - * Add templates for Issues and Pull Requests (`#1 `_) - * Set up the FastEddy Tutorial documentation (`#3 `_) - * Consolidate FastEddy-tutorials content into FastEddy-model (`#8 `_) - * Adjust FastEddy-tutorials BOMEX notebook & RTD Moist dynamics instructions for hosting datasets under new repo (`#10 `_) + * Add templates for Issues and Pull Requests + * Set up the FastEddy Tutorial documentation + * Consolidate FastEddy-tutorials content into FastEddy-model + * Adjust FastEddy-tutorials BOMEX notebook & RTD Moist dynamics instructions for hosting datasets under new repo .. dropdown:: Bugfixes - * Fix to the restart model capability (`#6 `_) - * Clean compile with warnings addressed (`#6 `_) + * Fix to the restart model capability + * Clean compile with warnings addressed .. dropdown:: Enhancements - * Accommodate building on Derecho (`#6 `_) + * Accommodate building on Derecho