Skip to content

Commit

Permalink
added Actions CI badge and more info about parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
phydev committed Oct 24, 2023
1 parent f2cd3fd commit 72db2fb
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
@@ -1,3 +1,7 @@
![build status](https://github.com/phydev/angio/actions/workflows/docker-image.yml/badge.svg)

----

## Angiogenesis Project
This project is hosted by the [CFisUC](http://cfisuc.fis.uc.pt/) at the [University of Coimbra](www.uc.pt)
and consists in a phase-field model for tumor angiogenesis. The model is based on the paper published by
Expand All @@ -16,6 +20,12 @@ and consists in a phase-field model for tumor angiogenesis. The model is based o
2. Run the container:
```docker run -it -v $(pwd):/code angio /bin/bash run.sh <run_id>```. Please make sure that an input file named ```inp<run_id>``` is present in the root directory of the project.

### Parameters

We provide typical parameters for simulations in [`input_file`](https://github.com/phydev/angio/blob/master/input_file).

Beware that the input file `inp001` is solely used to run the docker image with Github actions. The parameters were changed to produce a short simulation with small grid, few iterations, and no sources of VEGF. Please do __not__ base future studies on this file.

### Publications:
M. Moreira-Soares, R. Coimbra, L. Rebelo, J. Carvalho & R. D. M. Travasso. [Angiogenic Factors produced by Hypoxic Cells are a leading driver of Anastomoses in Sprouting Angiogenesis–a computational study](https://www.nature.com/articles/s41598-018-27034-8). Scientific Reports 8, 8726 (2018)

Expand Down

0 comments on commit 72db2fb

Please sign in to comment.