Skip to content

Commit 0a6ab3e

Browse files
authored
Merge pull request #15 from scientificcomputing/finsberg/readme
Update README
2 parents 73a4444 + f47d0f0 commit 0a6ab3e

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
11
# Scientific Computing Tools for Finite Element Methods
22

3-
TBW
3+
This package contains a collection of tools for scientific computing with a focus on finite element methods. The tools are written in Python and are intended to be used in conjunction with the [dolfinx](https://github.com/FEniCS/dolfinx).
4+
5+
Many users that are transitioning from legacy FEniCS to FEniCSx may find the transition difficult due to the lack of some functionalities in FEniCSx. This package aims to provide some of the functionalities that are missing in FEniCSx. The package is still in its early stages and many functionalities are still missing.
6+
7+
8+
## Installation
9+
10+
The package is partly written in C++ and relies on `dolfinx`. User are encouraged to install `scifem` in an environment where `dolfinx` is already installed. The package can be installed using `pip`:
11+
12+
```bash
13+
python3 -m pip install scifem --no-build-isolation
14+
```
15+
16+
17+
## Having issues or want to contribute?
18+
19+
If you are having issues, feature request or would like to contribute, please let us know. You can do so by opening an issue on the [issue tracker](https://github.com/scientificcomputing/scifem/issues).
20+
21+
422

523
## LICENSE
624
MIT

0 commit comments

Comments
 (0)