Skip to content

Commit 80114fc

Browse files
davidwilbydavidwilby
andauthored
Minor suggestions to installation docs. (#98)
* explicitly mention git clone url * tweak pip install command to avoid errors (at least with pip 23.3.1 * add note on virtual environments --------- Co-authored-by: davidwilby <[email protected]>
1 parent 4241544 commit 80114fc

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/getting-started/installation.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ This is the easiest way to install DeepSensor.
1212
pip install deepsensor
1313
```
1414

15+
```{note}
16+
We advise installing DeepSensor and its dependencies in a python virtual environment using a tool such as [venv](https://docs.python.org/3/library/venv.html) or [conda](https://conda.io/projects/conda/en/latest/user-guide/getting-started.html#managing-python) (other virtual environment managers are available).
17+
```
18+
1519
## Install DeepSensor from [source](https://github.com/tom-andersson/deepsensor)
1620

1721
```{note}
@@ -25,13 +29,13 @@ This method will create a `DeepSensor` directory on your machine which will cont
2529
- Clone the repository:
2630

2731
```bash
28-
git clone
32+
git clone https://github.com/tom-andersson/deepsensor
2933
```
3034

3135
- Install `DeepSensor`:
3236

3337
```bash
34-
pip install -e -v .
38+
pip install -v -e .
3539
```
3640
## Install PyTorch or TensorFlow
3741

0 commit comments

Comments
 (0)