Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
decryptofy authored May 25, 2024
1 parent 4710f40 commit b8494c3
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit b8494c3

Please sign in to comment.