Skip to content

Commit

Permalink
Simplify installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jannisborn authored Sep 15, 2023
1 parent 0b69b7d commit bf32549
Showing 1 changed file with 4 additions and 13 deletions.
17 changes: 4 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,26 +39,17 @@ The recommended way to install the `gt4sd` is to create a dedicated conda enviro
```sh
git clone https://github.com/GT4SD/gt4sd-core.git
cd gt4sd-core/
conda env create -f conda.yml
conda env create -f conda.yml
conda activate gt4sd
pip install gt4sd
```

**Note:** by default `gt4sd` is installed with CPU requirements on linux systems. If you have GPU available, run:

**NOTE 1:** By default `gt4sd` is installed with CPU requirements. For GPU usage replace `conda env create -f conda.yml` with:
```sh
git clone https://github.com/GT4SD/gt4sd-core.git
cd gt4sd-core/
conda env create -f conda_gpu.yml
conda activate gt4sd
```

And install the package via `pip` from [PyPI](https://pypi.org/project/gt4sd/):

```sh
pip install gt4sd
```

**NOTE:** In case you want to reuse an existing compatible environment (see [requirements](#requirements)), you can use `pip`, but as of now (:eyes: on [issue](https://github.com/GT4SD/gt4sd-core/issues/31) for changes), some dependencies require installation from GitHub, so for a complete setup install them with:
**NOTE 2:** In case you want to reuse an existing compatible environment (see [requirements](#requirements)), you can use `pip`, but as of now (:eyes: on [issue](https://github.com/GT4SD/gt4sd-core/issues/31) for changes), some dependencies require installation from GitHub, so for a complete setup install them with:

```sh
pip install -r vcs_requirements.txt
Expand Down

0 comments on commit bf32549

Please sign in to comment.