From dfca46915cb22aeeff6bd5fa79915c197f7bd45f Mon Sep 17 00:00:00 2001 From: Matteo Cencini Date: Fri, 26 Jan 2024 11:12:09 +0100 Subject: [PATCH] Adding _README --- _README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/_README.md b/_README.md index 4525e694..aaaf56b5 100644 --- a/_README.md +++ b/_README.md @@ -3,13 +3,27 @@

A framework to accelerate the development of modern MR acquisition and reconstruction methods, focused on quantitative MRI. -## Installation +Deep-MR can be installed using pip: + +1. Clone the repo + +```bash +git clone https://github.com/INFN-PREDATOR/deep-mr.git +``` + +2. Navigate to the repository root folder and install using pip: + +```bash +pip install . +``` + +or, for editable mode: ```bash -$ pip install deepmr +pip install -e . ``` -## Usage +## UsageUsage - TODO