From 725182193f5a5832a9cd74d1aa3fcd5d64be4f94 Mon Sep 17 00:00:00 2001 From: HKjeldsberg Date: Mon, 23 Sep 2024 17:22:59 +0200 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 38ff9fe..541a843 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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: @@ -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) \ No newline at end of file +Henrik A. Kjeldsberg [Email](mailto:henrik.kjeldsberg@live.no)