diff --git a/README.md b/README.md index 56fb03b7fd5aa12c1b9b5bd6d5e36f468f73b965..03f9eaf8b77fbcf61aa6a60db51320c7d353132e 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,9 @@ The reason for this module is to administer different versions of each operator. it might be possible to use AVX512, AVX2 or no vectorization at all. The module will choose the correct type of vectorization for you, generate and build it. (More precisely, it generates a non-vectorized and a vectorized version alongside logic which chooses the desired version at build time (automatically).) +Depending on the operator you are adding you might also need to extend `hyteg-operators/generate/generate.py`, e.g. if you want to use a new FE space or +blending map. + ### Step 3: Operator generation Generate the operator by creating a virtual environment including the HOG and running `hyteg-operators/generate/generate.py`: @@ -70,6 +73,11 @@ python generate.py -o ../operators ../operators.toml The generated operator will be saved at `hyteg-operators/operators`. Note: the pointer to HOG in the `requirements.txt` should point to the commit you published the form on or, if you have not published it, to you local HOG repository. +For a full list of options run +```sh +python generate.py -h +``` + ### Step 4: Linking and including in Apps Link your application against the operator in the corresponding `CMakeLists.txt`: ```cmake