Skip to content

Commit

Permalink
Feature 48 release 2.0 (#49)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
jprestop authored Aug 9, 2024
1 parent d19052a commit 2e0d0f1
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 13 deletions.
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 ---------------------------------------------------
Expand Down
6 changes: 5 additions & 1 deletion docs/downloads.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/NCAR/FastEddy-model/archive/refs/tags/v2.0.0.tar.gz>`_
- `v2.0.0 Release Notes <https://fasteddy-model.readthedocs.io/en/main_v2.0/release_notes.html>`_
* - 1.1.0
- April 22, 2024
- `v1.1.0.tar.gz <https://github.com/NCAR/FastEddy-model/archive/refs/tags/v1.1.0.tar.gz>`_
Expand Down
13 changes: 13 additions & 0 deletions docs/publications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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ć.
Expand Down
41 changes: 31 additions & 10 deletions docs/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/NCAR/FastEddy-model/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)
===================================================

Expand All @@ -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 <https://github.com/NCAR/FastEddy-model/issues/1>`_)
* Set up the FastEddy Tutorial documentation (`#3 <https://github.com/NCAR/FastEddy-model/issues/3>`_)
* Consolidate FastEddy-tutorials content into FastEddy-model (`#8 <https://github.com/NCAR/FastEddy-model/issues/8>`_)
* Adjust FastEddy-tutorials BOMEX notebook & RTD Moist dynamics instructions for hosting datasets under new repo (`#10 <https://github.com/NCAR/FastEddy-model/issues/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 <https://github.com/NCAR/FastEddy-model/pull/6>`_)
* Clean compile with warnings addressed (`#6 <https://github.com/NCAR/FastEddy-model/pull/6>`_)
* Fix to the restart model capability
* Clean compile with warnings addressed

.. dropdown:: Enhancements

* Accommodate building on Derecho (`#6 <https://github.com/NCAR/FastEddy-model/pull/6>`_)
* Accommodate building on Derecho


0 comments on commit 2e0d0f1

Please sign in to comment.