Skip to content

Commit

Permalink
Update _ to - in name
Browse files Browse the repository at this point in the history
  • Loading branch information
finsberg committed Aug 21, 2024
1 parent 6fafa41 commit 0d20870
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ Currently you can create bi-ventricular (BiV) and left-ventricular (LV) ellipsoi
This package can also output analytic fiber orientations for LV and Slab and integrated with the [ldrb](https://github.com/finsberg/ldrb) algorithm BiV geometries.

## Install
User are encourage to use the the [provided docker image](https://github.com/ComputationalPhysiology/cardiac_geometries/pkgs/container/cardiac_geometries)
User are encourage to use the the [provided docker image](https://github.com/ComputationalPhysiology/cardiac_geometries/pkgs/container/cardiac-geometries)
```
docker pull ghcr.io/computationalphysiology/cardiac_geometries:latest
docker pull ghcr.io/computationalphysiology/cardiac-geometries:latest
```
which comes pre-installed with FEniCs and gmsh.

You can also install `cardiac-geometries` using `pip`
```
python3 -m pip install cardiac-geometries
```
but this requires FEniCS and gmsh to be installed in other ways. See more at https://computationalphysiology.github.io/cardiac_geometries/install.html
but this requires FEniCS and gmsh to be installed in other ways. See more at https://computationalphysiology.github.io/cardiac-geometries/install.html

## Getting started
`cardiac-geometries` comes with a command-line interface, and to e.g create an LV mesh you can do
Expand All @@ -30,14 +30,14 @@ import cardiac_geometries

geo = cardiac_geometries.mesh.create_lv_ellipsoid(outdir="lv-mesh")
```
See https://computationalphysiology.github.io/cardiac_geometries/quickstart.html for more info.
See https://computationalphysiology.github.io/cardiac-geometries/quickstart.html for more info.


## Documentation
Please read the documentation at http://computationalphysiology.github.io/cardiac_geometries for more info.
Please read the documentation at http://computationalphysiology.github.io/cardiac-geometries for more info.

## Contributing
See https://computationalphysiology.github.io/cardiac_geometries/CONTRIBUTING.html
See https://computationalphysiology.github.io/cardiac-geometries/CONTRIBUTING.html

## License
MIT
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ file = "README.md"
content-type = "text/markdown"

[project.urls]
Homepage = "https://github.com/ComputationalPhysiology/cardiac_geometries"
Homepage = "https://github.com/ComputationalPhysiology/cardiac-geometries"

[project.optional-dependencies]
dev = [
Expand Down

0 comments on commit 0d20870

Please sign in to comment.