From 0177cdfbe26f1fb26f039898a830333881e14aca Mon Sep 17 00:00:00 2001 From: Ann Almgren Date: Wed, 20 Nov 2024 13:03:23 -0800 Subject: [PATCH 1/2] add link to WoA grid (#1965) --- Docs/sphinx_doc/Meshing.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Docs/sphinx_doc/Meshing.rst b/Docs/sphinx_doc/Meshing.rst index a88b93bae..c0d9f6141 100644 --- a/Docs/sphinx_doc/Meshing.rst +++ b/Docs/sphinx_doc/Meshing.rst @@ -13,6 +13,10 @@ Simulations over complex topography use a terrain-following, height-based vertic When terrain-following coordinates are used, the surface topography at nodes (cell corners) is specified either analytically or through parsing a text file; all metric terms derive from this quantity. +See `WoA`_ for an example of a terrain-fitted grid; this one follows the Witch of Agnesi profile. + +.. _`WoA`: https://github.com/erf-model/validation/blob/main/JAMES_Paper/Flow_Over_Terrain/WoA_mesh.png + As in many atmospheric modeling codes, variable mesh spacing in the vertical direction is allowed with or without terrain. The heights of each level can be parsed from a text file as ``z levels'' (as in WRF), or calculated at run-time given an initial mesh spacing at the bottom surface and a specified growth rate. In the presence of non-flat terrain, the mesh is From f99dd8674f7a6221dbb20ba0cedb0e3ffc9f6886 Mon Sep 17 00:00:00 2001 From: Ann Almgren Date: Wed, 20 Nov 2024 13:19:22 -0800 Subject: [PATCH 2/2] add info on how to cite ERF (#1966) --- Docs/sphinx_doc/HowToCite.rst | 27 +++++++++++++++++++++++++++ Docs/sphinx_doc/index.rst | 1 + 2 files changed, 28 insertions(+) create mode 100644 Docs/sphinx_doc/HowToCite.rst diff --git a/Docs/sphinx_doc/HowToCite.rst b/Docs/sphinx_doc/HowToCite.rst new file mode 100644 index 000000000..5bf5f7374 --- /dev/null +++ b/Docs/sphinx_doc/HowToCite.rst @@ -0,0 +1,27 @@ + .. role:: cpp(code) + :language: c++ + +.. _HowToCite: + +How to Cite ERF +=============== + +If you use ERF, please cite the following reference. + +Almgren et al., (2023). ERF: Energy Research and Forecasting. Journal of Open Source Software, 8(87), 5202, https://doi.org/10.21105/joss.05202 + +The bibtex version would be + +@article{Almgren2023, + title = {ERF: Energy Research and Forecasting}, + journal = {Journal of Open Source Software} + author = {Ann Almgren and Aaron Lattanzi and Riyaz Haque and Pankaj Jha and Branko Kosovic and Jeffrey Mirocha and Bruce Perry and Eliot Quon and Michael Sanders and David Wiersema and Donald Willcox and Xingqiu Yuan and Weiqun Zhang}, + doi = {10.21105/joss.05202}, + url = {https://doi.org/10.21105/joss.05202}, + year = {2023}, + publisher = {The Open Journal of Open Source Software}, + volume = {8}, + number = {87}, + pages = {5202}, +} + diff --git a/Docs/sphinx_doc/index.rst b/Docs/sphinx_doc/index.rst index 1fd4a536c..aefbf3798 100644 --- a/Docs/sphinx_doc/index.rst +++ b/Docs/sphinx_doc/index.rst @@ -40,6 +40,7 @@ In addition to this documentation, there is API documentation for ERF generated GettingStarted.rst Inputs.rst BestPractices.rst + HowToCite.rst .. toctree:: :caption: THEORY