Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hkjeldsberg authored Sep 23, 2024
1 parent c959581 commit 7251821
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ and optimization methods. The package supports both atrial fibrillation (AF) and
- Visualize and analyze atrial flow using various plotting tools
- Configurable flow rate calculation using geometrical and hemodynamic data

## Installation

### Requirements
## Requirements

- Python 3.10 or later
- Dependencies:
Expand All @@ -22,13 +20,22 @@ and optimization methods. The package supports both atrial fibrillation (AF) and
- `pandas>=1.0`
- `scipy>=1.5.0`
- `seaborn>=0.11.0`
## Installation

To install `AtriFlow`, clone the repository:

To install the package and its dependencies, run:
```bash
git clone https://github.com/KVSlab/AtriFlow.git
```

Then navigate inside the `AtriFlow` folder and install its dependencies in a Python environment:

```bash
pip install .
python -m pip install .
```

Successful execution will install `AtriFlow` to your computer.

### Optional Development Dependencies

If you want to run tests and perform code formatting, install the optional dependencies:
Expand Down Expand Up @@ -67,4 +74,4 @@ This will store flow rate files in the 'data/flow_rates' folder.

## Author

Henrik A. Kjeldsberg [Email](mailto:henrik.kjeldsberg@live.no)
Henrik A. Kjeldsberg [Email](mailto:henrik.kjeldsberg@live.no)

0 comments on commit 7251821

Please sign in to comment.