Skip to content

Commit 2e28b11

Browse files
Merge pull request #8 from IBM/fix/tutorial_notebook
Improve tutorial notebook
2 parents f173c1e + 8fbc685 commit 2e28b11

File tree

4 files changed

+356
-258
lines changed

4 files changed

+356
-258
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ The library provides:
1616
### Pip
1717
In order to use th file `pyproject.toml` it is necessary to guarantee `pip>=21.8`. If necessary upgrade `pip` using `python -m pip install --upgrade pip`.
1818

19-
Install the library with `pip install git+https://github.com/IBM/terratorch.git`
19+
Install the library with `pip install git+https://github.com/IBM/terratorch.git`.
20+
21+
TerraTorch requires gdal to be installed, which can be quite a complex process. If you don't have GDAL set up on your system, we reccomend using a conda environment and installing it with `conda install -c conda-forge gdal`.
2022

2123
To install as a developer (e.g. to extend the library) clone this repo, install dependencies using `pip install -r requirements.txt` and run `pip install -e .`
2224

docs/quick_start.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Quick start
22
We suggest using Python==3.10.
3-
To get started, make sure to have `PyTorch >= 2` [installed](https://pytorch.org/get-started/locally/).
3+
To get started, make sure to have [PyTorch](https://pytorch.org/get-started/locally/) >= 2.0.0 and [GDAL](https://gdal.org/index.html) installed.
4+
5+
Installing GDAL can be quite a complex process. If you don't have GDAL set up on your system, we reccomend using a conda environment and installing it with `conda install -c conda-forge gdal`.
46

57
Install TerraTorch with `pip install git+https://github.com/IBM/terratorch.git`
68

examples/notebooks/Tutorial.ipynb

+350-256
Large diffs are not rendered by default.
Binary file not shown.

0 commit comments

Comments
 (0)