From b8494c3fc4884f6e1f63f26970c57bef1f2cd883 Mon Sep 17 00:00:00 2001 From: decryptofy <96751659+decryptofy@users.noreply.github.com> Date: Sat, 25 May 2024 12:47:00 -0700 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8e2fde4..5a8564d 100644 --- a/README.md +++ b/README.md @@ -34,19 +34,28 @@ SCARR also aims at maximizing I/O efficiency, including the asynchronous prefetc # Install -SCARR should be installed with pip3 from GitHub directly: +SCARR can be installed with pip3 from GitHub directly: ``` pip3 install "git+https://github.com/decryptofy/scarr.git" ``` -*Alternatively*, you can clone the repository and install from your local copy using: +*Alternatively*, you can clone the repository to also get the most recent versions of the [Jupyter](https://jupyter.org/) notebooks: ``` +git clone git@github.com:decryptofy/scarr.git +cd scarr +git submodule update --init jupyter python3 -m pip install . ``` -Please note: the reference OS for SCARR is Ubuntu 22.04 LTS with its default Python 3.10. +Afterwards, you can install SCARR by typing: + +``` +python3 -m pip install . +``` + +Please note: the reference OS for SCARR is Ubuntu 22.04 LTS with its default Python 3.10. To make use of the provided Jupyter notebooks, you may want to use [VS Code](https://code.visualstudio.com/) and its [Jupyter plugin](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter), or [PyCharm](https://www.jetbrains.com/pycharm/), but any other options to run Jupyter notebooks should work, too. # Usage Warning