Merge pull request #58 from kumiori/andres-joss-review

Andres joss review - cleaning tests & CI workflow

Author: kumiori

.github/workflows/pull-image.yml

@@ -0,0 +1,28 @@
+name: Run Tests in Docker Container
+run-name: We are testing irrevolutions
+
+on:
+  push:
+    branches:
+      - "**"
+
+jobs:
+  set-up-computing-environment:
+    runs-on: ubuntu-latest
+    container: kumiori3/numerix:stable-amd64
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: python3 -m pip install .
+
+      - name: Test import
+        run: python3 -c "import irrevolutions"
+
+      - name: Run 1d test
+        run: pytest -v test/test_1d.py
+
+      - name: Run tests
+        run: cd test && pytest -v .

.github/workflows/workflow.yaml

@@ -51,4 +51,7 @@ docs/build/
 test_*/
 src/irrevolutions/test/output/*
 **/output/**
-**egg-info**
+**egg-info**
+
+# python virtual environment  
+.venv/**

.gitignore

@@ -0,0 +1 @@
+include irrevolutions/models/default_parameters.yml

MANIFEST.in

@@ -45,6 +45,13 @@ On a windows box:
 docker run --rm -ti -v "C:/...":/home/numerix" -w /home/numerix kumiori3\numerix:latest
 ```
 
+To install the software, run DOLFINx through the aforementioned docker container and install the irrevolutions-package with 
+
+```python3 -m pip install .```
+
+from the root of this repository
+
+
 This code was initially conceived as a support for the teaching course MEC647, 
 (Complex) Crack Propagation in Brittle Materials, delivered to the students of the international
 master programme, joint between École Polytechnique and ENSTA-Paristech throughout 2020-2022.