Skip to content

Commit 31eab3e

Browse files
committed
Updated package installation instructions
1 parent e8af103 commit 31eab3e

2 files changed

Lines changed: 18 additions & 3 deletions

File tree

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,18 @@ conda create -n thunder_env python=3.10
6868
conda activate thunder_env
6969
```
7070

71-
To install `thunder` run the following command:
71+
To install `thunder` run one of the following commands:
7272

73+
#### From PyPi
74+
```console
75+
pip install thunder-bench
76+
```
77+
78+
#### From Source
7379
```console
7480
pip install -e . # install the package in editable mode
81+
```
82+
```console
7583
pip install . # install the package
7684
```
7785

docs/getting_started.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
## Installation
22

3-
In order to use the package, you need to install it first. You can do this by running the following command in your terminal:
3+
In order to use the package, you need to install it first. You can do this by running one of the following commands in your terminal:
4+
5+
```console
6+
pip install thunder-bench # from Pypi
7+
```
48

59
```console
610
pip install git+https://github.com/MICS-Lab/thunder.git
@@ -9,7 +13,10 @@ pip install git+https://github.com/MICS-Lab/thunder.git
913
or you can clone the repository and install it locally like so:
1014

1115
```console
12-
pip install .
16+
pip install -e . # install the package in editable mode
17+
```
18+
```console
19+
pip install . # install the package
1320
```
1421

1522
The package is storing all the datasets, models and results under a folder that you will need to define through the environment variable `THUNDER_BASE_DATA_FOLDER`. You can do this by running the following command in your terminal:

0 commit comments

Comments
 (0)