Commit d2e2c49a authored by Stauff, Nicolas Emile's avatar Stauff, Nicolas Emile
Browse files

Merge branch 'proto' into 'main'

Extension of PyGriffin configuration for isoxml, meshing. Enabling CI.

See merge request nstauff/PyGriffin!6
parents 0b271b95 7951f70b
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
**/*__pycache__
*.code-workspace
.pygriffin.rc

.gitlab-ci.yml

0 → 100644
+12 −0
Original line number Diff line number Diff line
default:
  tags:
    - pygriffin-docker

stages:
  - build_and_test

build_and_test:
  stage: build_and_test
  script:
    - pip install .[test]
    - pytest -v ./tests
+1 −1
Original line number Diff line number Diff line
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at pshriwise@anl.gov or nstauff@anl.gov.
reported by contacting the project team at pygriffin@anl.gov.
All complaints will be reviewed and investigated and will result in a response
that is deemed necessary and appropriate to the circumstances. The project team
is obligated to maintain confidentiality with regard to the reporter of an
+30 −4
Original line number Diff line number Diff line
@@ -2,7 +2,10 @@

## Prerequisites

  - Required:
    - [NumPy](https://numpy.org/)
  - Optional:
    - [pytest](https://docs.pytest.org/en/6.2.x/)

## Configuring PyGriffin

@@ -20,13 +23,36 @@ 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.
PyGriffin can be installed by using pip (`pip install .` from the repository's
top directory) or by adding the locatiion of the PyGriffin repository to your
`PYTHONPATH` variable.

```bash
$ export PYTHONPATH=/path/to/pygriffin/repository
```

When installing with pip, PyGriffin's test dependencies can be included using:

```bash
$ pip install .[test]
```

## Testing

Move to the `tests` directory of PyGriffin and run:
With the testing prerequisites installed. Run the following command to test

```bash
pytest -v
```

## Detecting MPI

PyGriffin currently interrogates the MOOSE installation upon initialization to
determine if Griffin was built with MPI. To check if MPI parallelism is enabled
use the following command:

```python
>>> from pygriffin import PyGriffin
>>> pyg = PyGriffin('griffin.i')
>>> pyg.mpi_enabled
```
 No newline at end of file
+1 −2
Original line number Diff line number Diff line
__version__ = '0.0.1'

from pygriffin.config import *
from pygriffin.pygriffin import *
from .pygriffin import *
Loading