Commit 304480a1 authored by Patrick Shriwise's avatar Patrick Shriwise
Browse files

Updating README.

parent 1218d6ae

README.md

+16 −0
Original line number Diff line number Diff line 
# PyGriffin



## Prerequisites



  - [NumPy](https://numpy.org/)



## Configuring PyGriffin
@@ -14,3 +17,16 @@ There are a number to indicate location of the Griffin executable to PyGriffin. 


These will be preferentially used by PyGriffin in the order they are provided by

the user and the user's compute environment.



## Installing



For now, the best method for installing PyGriffin is to add the top of the

PyGriffin repository to your `PYTHONPATH.



## Testing



Move to the `tests` directory of PyGriffin and run:



```bash

pytest -v

```