Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
finsberg committed Feb 26, 2024
1 parent 2e7b023 commit 7c927a8
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,20 @@ Gmsh files for caridac geometries

Source code : https://github.com/ComputationalPhysiology/cardiac-geometries-core


## Install
You can install the package with pip
```
python3 -m pip install cardiac-geometries-core
```
or you can just run a container without any installation, i.e
```
docker run --rm -w /home/shared -v $PWD:/home/shared -it ghcr.io/computationalphysiology/cardiac-geometries-core:latest
```
For example the following command will create an lv ellipsoid and save it to a file called `lv-mesh.msh`
```
docker run --rm -w /home/shared -v $PWD:/home/shared -it ghcr.io/computationalphysiology/cardiac-geometries-core:latest lv-ellipsoid lv-mesh.msh
```

## Authors
Henrik Finsberg (henriknf@simula.no)
Expand Down

0 comments on commit 7c927a8

Please sign in to comment.