Skip to content

Commit

Permalink
further markdown + rst integration
Browse files Browse the repository at this point in the history
  • Loading branch information
mbkuhn committed Oct 22, 2024
1 parent 254353c commit e7912a8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 16 deletions.
15 changes: 1 addition & 14 deletions .website_src/index.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,4 @@
====================
ExaWind Benchmarks
====================

These are reference problems used to evaluate and compare the performance
of ExaWind. These benchmarks have been chosen to represent the various
capabilities within the ExaWind software stack, featuring cases for each
individual solver (AMR-Wind and Nalu-Wind) and the overset hybrid solver.
By providing up-to-date examples in an applied context, they also serve as
a starting point for researchers setting up similar simulations.

This repository is intended to become a nexus for collaborating among
research groups, providing a reference frame for other code capabilities,
and hosting external contributions.
.. mdinclude:: ../README.md

.. toctree::
:maxdepth: 2
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# exawind-benchmarks
# ExaWind Benchmarks
These are reference problems used to evaluate and compare the performance of ExaWind. These benchmarks have been chosen to represent the various capabilities within the ExaWind software stack, featuring cases for each individual solver (AMR-Wind and Nalu-Wind) and the overset hybrid solver. By providing up-to-date examples in an applied context, they also serve as a starting point for researchers setting up similar simulations.

Benchmark problems are divided by the ExaWind program used to perform the simulation, whether that is amr-wind alone, nalu-wind alone, or the full overset solver, exawind. For each problem included, the files required to run the case are included in an input_files directory, information about the latest run is contained in a run_info directory, and output data is compiled in a performance directory. Run information primarily includes the headers log files, which are intended to capture the git hash version used to run each specific example, and the footers of log files, which are intended to display profiling and timing data available at the end of the run, as well as explicitly showing how many time steps were taken in the simulation. Performance broadly includes both measured results from the simulation, such as physical quantities of interest, and computational timing information.
This repository is intended to become a nexus for collaborating among
research groups, providing a reference frame for other code capabilities,
and hosting external contributions.

Benchmark problems are grouped by the ExaWind program used to perform the simulation. For each problem included in the repository, the files required to run the case are included in an input_files directory, information about the latest run is contained in a run_info directory, and output data is compiled in a performance directory. Run information primarily includes the headers of log files, which capture the git hash/version recently used to run each specific example, and the footers of log files, which display profiling data and the number of time steps taken. Performance broadly includes both measured results from the simulation, such as physical quantities of interest, and computational timing information. README files provide synopses of each case and the resources used.

0 comments on commit e7912a8

Please sign in to comment.