@@ -26,7 +26,9 @@ the user and the user's compute environment.
The `.pygriffin.rc` file uses a configuration format commmonly adopted
by Python modules for customization that is supported by a a parser in
the Python standard library. Specifics on this format can be found
[here](https://docs.fileformat.com/system/ini/).
[here](https://docs.fileformat.com/system/ini/). This file can be located in the base of the PyGriffin repository or in the
user's home directory. A configuration file in the user's home directory will override one found in the repository. When installing PyGriffin using pip, a `.pygriffin.rc` file in the
user's home directory will be necessary.
PyGriffin expects to find an `exec` section in this file containing
the location of the Griffin executable and (optionally) the ISOXML
@@ -51,6 +53,17 @@ print(pyg_config.griffin_exec)
This file can be updated to change the executables used by
PyGriffin the next time the package is imported.
For Griffin execution with MPI, an executable can be specified
by adding a `mpi` entry to the `.pygriffin.rc` file in the `exec`
block
```
[exec]
griffin = /home/griffin_project/griffin-opt
isoxml = /home/griffin_project/isoxml/isoxml-opt
mpi = /path/to/my/mpiexec
```
## Installing
PyGriffin can be installed by using pip (`pip install .` from the repository's
