From 590854abb29b4f0eec555703fd2ec41cacc0c56a Mon Sep 17 00:00:00 2001 From: Maciej Waruszewski Date: Mon, 13 May 2024 09:31:28 -0600 Subject: [PATCH] Update docs with info on obtaining test meshes --- components/omega/doc/devGuide/QuickStart.md | 27 ++++++++++++++------ components/omega/doc/userGuide/OmegaBuild.md | 3 ++- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/components/omega/doc/devGuide/QuickStart.md b/components/omega/doc/devGuide/QuickStart.md index 5b6d64aeee34..bf7d6aaa834b 100644 --- a/components/omega/doc/devGuide/QuickStart.md +++ b/components/omega/doc/devGuide/QuickStart.md @@ -130,18 +130,29 @@ script that you can run to build Omega: ./omega_build.sh ``` +(omega-dev-quick-start-getting-meshes)= +### Getting test meshes + +Some tests require a valid Omega mesh file. Different tests require different meshes. At the moment, mesh files need +to be copied or linked to specifically named files under the `test` directory. Appropriate mesh files can be downloaded from: +- [Ocean Mesh](https://web.lcrc.anl.gov/public/e3sm/inputdata/ocn/mpas-o/oQU240/ocean.QU.240km.151209.nc) +- [Global Mesh](https://web.lcrc.anl.gov/public/e3sm/polaris/ocean/polaris_cache/global_convergence/icos/cosine_bell/Icos480/init/initial_state.230220.nc) +- [Planar Mesh](https://gist.github.com/mwarusz/f8caf260398dbe140d2102ec46a41268/raw/e3c29afbadc835797604369114321d93fd69886d/PlanarPeriodic48x48.nc) +```sh +wget -O ocean_test_mesh.nc https://web.lcrc.anl.gov/public/e3sm/inputdata/ocn/mpas-o/oQU240/ocean.QU.240km.151209.nc +wget -O global_test_mesh.nc https://web.lcrc.anl.gov/public/e3sm/polaris/ocean/polaris_cache/global_convergence/icos/cosine_bell/Icos480/init/initial_state.230220.nc +wget -O planar_test_mesh.nc https://gist.github.com/mwarusz/f8caf260398dbe140d2102ec46a41268/raw/e3c29afbadc835797604369114321d93fd69886d/PlanarPeriodic48x48.nc +ln -sf ocean_test_mesh.nc test/OmegaMesh.nc +ln -sf global_test_mesh.nc test/OmegaSphereMesh.nc +ln -sf planar_test_mesh.nc test/OmegaPlanarMesh.nc +``` + ### Running CTests Omega includes several unit tests that run through CTest. These need to be -run on a compute node. Some tests also require a valid Omega mesh file -called `test/OmegaMesh.nc`. An appropriate mesh file can be downloaded from -[mesh.230220.nc](https://web.lcrc.anl.gov/public/e3sm/polaris/ocean/omega_ctest/ocean.QU.240km.151209.nc). -```sh -wget https://web.lcrc.anl.gov/public/e3sm/polaris/ocean/omega_ctest/ocean.QU.240km.151209.nc -mv ocean.QU.240km.151209.nc test/OmegaMesh.nc -``` +run on a compute node. -Then, run the tests: +To run the tests: ```sh ./omega_ctest.sh ``` diff --git a/components/omega/doc/userGuide/OmegaBuild.md b/components/omega/doc/userGuide/OmegaBuild.md index 6fdcfe130656..5ba7e13f6801 100644 --- a/components/omega/doc/userGuide/OmegaBuild.md +++ b/components/omega/doc/userGuide/OmegaBuild.md @@ -132,7 +132,8 @@ parallel job launcher such as SLURM srun should be available. You may first get allocation of an interactive computing node or use batch system. In addition, you must either copy (or soft link) a mesh file into the same directory as the unit test executables or specify in a configuration file -(not implemented yet) the path to that mesh input file. +(not implemented yet) the path to that mesh input file. For detailed instructions +on how to obtain appropiate test meshes see {ref}`omega-dev-quick-start-getting-meshes`. For example, if you are on an interactive computing node, you can run Omega unit test by running `omega_ctest.sh` as shown below.