Skip to content

Commit 228d32c

Browse files
committed
Update README.
1 parent ac13466 commit 228d32c

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ numerical methods for solving a wide range of thin structural models (beams,
1212
plates and shells) expressed in the Unified Form Language (UFL) of the FEniCS
1313
Project.
1414

15-
*FEniCSx-Shells is an experimental version targeting version v0.10.0.dev0 of the new
15+
*FEniCSx-Shells is an experimental version targeting version v0.10.0 of the new
1616
[DOLFINx solver](https://github.com/fenics/dolfinx).*
1717

1818
The foundational aspects of the FEniCS-Shells project are described in the paper:
@@ -22,6 +22,20 @@ code generation tools, J. S. Hale, M. Brunetti, S. P. A. Bordas, C. Maurini.
2222
Computers & Structures, 209, 163-181,
2323
[doi:10.1016/j.compstruc.2018.08.001](https://doi.org/10.1016/j.compstruc.2018.08.001).
2424

25+
## Installation
26+
27+
See the [DOLFINx README -
28+
Installation](https://github.com/FEniCS/dolfinx/blob/main/README.md#installation) for
29+
instructions on installing DOLFINx with petsc4py support.
30+
31+
Then:
32+
33+
pip install fenicsx-shells[demos]@git+https://github.com/FEniCS-Shells/fenicsx-shells.git
34+
35+
At the current time, the `fenicsx-shells` module is empty, and the content of
36+
the 'library' is in the demos. This may change as we begin implementing e.g.
37+
custom assemblers.
38+
2539
## Documentation
2640

2741
The documentation can be viewed [here](https://fenics-shells.github.io/fenicsx-shells).
@@ -33,8 +47,6 @@ FEniCSx-Shells currently includes implementations of the following structural mo
3347
* Reissner-Mindlin plates.
3448
* Kirchhoff-Love plates.
3549

36-
A roadmap for future developments will be shared soon.
37-
3850
We are using a variety of numerical techniques for discretising the PDEs
3951
including:
4052

launch-container.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/bin/bash
22
CONTAINER_ENGINE="podman"
3-
${CONTAINER_ENGINE} run -ti -v $(pwd):/shared -w /shared dolfinx/dolfinx:v0.10.0-r1
3+
${CONTAINER_ENGINE} run --rm -ti -v $(pwd):/shared -w /shared dolfinx/dolfinx:v0.10.0-r1

0 commit comments

Comments
 (0)