Merge branch 'extend/docs' of github.com:IBM/terratorch into extend/docs

Author: Joao-L-S-Almeida

README.md

@@ -17,7 +17,9 @@ The library provides:
 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`. 
 
 For a stable point-release, use `pip install terratorch`. 
-If you prefer to get the most recent version of the main branch, install the library with `pip install git+https://github.com/IBM/terratorch.git`
+If you prefer to get the most recent version of the main branch, install the library with `pip install git+https://github.com/IBM/terratorch.git`.
+
+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`.
 
 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 .`
 

docs/quick_start.md

@@ -1,6 +1,8 @@
 # Quick start
 We suggest using Python==3.10.
-To get started, make sure to have `PyTorch >= 2` [installed](https://pytorch.org/get-started/locally/). 
+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. 
+
+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`.
 
 For a stable point-release, use `pip install terratorch`. 
 If you prefer to get the most recent version of the main branch, install the library with `pip install git+https://github.com/IBM/terratorch.git`.

examples/notebooks/Tutorial.ipynb

@@ -4,8 +4,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = "terratorch"
-#version = "0.99.0"
-dynamic = ["version"]
+version = "0.99.0"
 description = "TerraTorch - A model training toolkit for geospatial tasks"
 license = { "text" = "Apache License, Version 2.0" }
 readme = "README.md"
@@ -143,10 +142,6 @@ exclude_lines = [
   "if TYPE_CHECKING:",
 ]
 
-#[tool.setuptools.packages.find]
-#include = ["terratorch"]
-#namespaces = false
-
 [tool.bumpver]
 current_version = "0.99.0"
 version_pattern = "MAJOR.MINOR.PATCH[PYTAGNUM]"