From 10f1ae9fe9877db0c11d180323253234220652cc Mon Sep 17 00:00:00 2001 From: phlndrwd Date: Fri, 13 Oct 2023 17:42:15 +0100 Subject: [PATCH] Further modifications to README. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b608e98..ce021da 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ After satisfying the dependencies outlined above, MONIO was built and tested usi MONIO has been written to address the known use cases defined within the MO-JEDI context. These are captured in the public functons defined in the `Monio` singleton class. Once `Monio.h` is included in a source file it can be used directly. -In the following scenarios, the only common parameter is an `atlas::FieldSet` that uses an `atlas::CubedSphereGrid` and an `atlas::Mesh` configured as a `"cubedsphere_dual"`. Passing a `atlas::FieldSet` of a different configuration may cause issues that prevent MONIO from functioning correctly. +In the following scenarios, the only common parameter is an `atlas::FieldSet` that uses an `atlas::CubedSphereGrid` and an `atlas::Mesh` configured as a `"cubedsphere_dual"`. Passing a `atlas::FieldSet` of a different configuration can prevent MONIO from functioning correctly. Most of the functions in `monio::Monio` also take a reference to a `std::vector`. This is a standard C++ `std::vector` of `consts::FieldMetadata` structs defined in MONIO's `Constants.h` file. The struct instances in this vector must correspond to a `atlas::Field` in the `atlas::FieldSet`. They are accessed by the value of `FieldMetadata.jediName`. If a `atlas::Field` in the `atlas::FieldSet` has no corresponding instance of `consts::FieldMetadata`, they will not be processed. If an instance of `consts::FieldMetadata` does not correspond to a `atlas::Field` in the `atlas::FieldSet`, an exeption will be generated and program execution will cease.