Skip to content

Commit a5df49d

Browse files
author
Matic Lubej
authored
update readme according to dependency changes (#749)
1 parent 4693f13 commit a5df49d

File tree

1 file changed

+24
-28
lines changed

1 file changed

+24
-28
lines changed

README.md

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,24 @@ The modules are:
5252

5353
### Requirements
5454

55-
#### Linux / Mac OS
55+
The package requires Python version **>=3.8**.
56+
57+
#### Linux
5658

5759
Before installing `eo-learn` on **Linux** it is recommended to install the following system libraries:
5860

5961
```bash
6062
sudo apt-get install gcc libgdal-dev graphviz proj-bin libproj-dev libspatialindex-dev
6163
```
6264

65+
#### Mac OS
66+
67+
Before installing `eo-learn` on `Mac OS` it is recommended to install the following system libraries with [Homebrew](https://brew.sh/):
68+
69+
```bash
70+
brew install graphviz gcc gdal cmake spatialindex proj
71+
```
72+
6373
#### Windows
6474

6575
Before installing `eo-learn` on **Windows** it is recommended to install the following packages from [Unofficial Windows wheels repository](https://www.lfd.uci.edu/~gohlke/pythonlibs/):
@@ -73,45 +83,31 @@ fiona
7383

7484
One of the `[MASK_EXTRA]` dependencies is the `lightgbm` package. On Windows it requires 64 bit Python distribution. If having problems during installation please check [LightGBM installation guide](https://lightgbm.readthedocs.io/en/latest/Installation-Guide.html).
7585

76-
### PyPi distribution
86+
### PyPI distribution
7787

78-
The package requires Python version **>=3.8** . If this is your first time installing `eo-learn`, or you aren't sure what kind of installation you require, then you can safely install it with:
79-
80-
```bash
81-
pip install "eo-learn[ALL]"
82-
```
83-
84-
To better control your dependencies, you can install just the core dependencies of `eo-learn` with:
88+
`eo-learn` is available on PyPI and can be installed with:
8589

8690
```bash
8791
pip install eo-learn
8892
```
8993

90-
Alternatively, you can decide for yourself which modules you want to be operational by providing the corresponding extras. E.g., if you are only interested in the `io` and `mask` modules, or in the extra dependencies of the `features` module, you can install them with:
94+
For some modules there are extra dependencies available, related to specific tasks. These were kept separate in order to keep the `eo-learn` installation light. You can install these with, e.g.:
9195

9296
```bash
93-
pip install "eo-learn[IO, MASK]"
94-
pip install "eo-learn[FEATURES_EXTRA]"
97+
pip install "eo-learn[MASK_EXTRA]"
98+
pip install "eo-learn[VISUALIZATION]"
9599
```
96100

97-
Here is a full list of all the modules' dependencies and their extras:
98-
99-
- `COREGISTRATION`
100-
- `FEATURES` and `FEATURES_EXTRA`
101-
- `GEOMETRY`
102-
- `IO`
103-
- `MASK` and `MASK_EXTRA`
104-
- `MLTOOLS`
105-
- `VISUALIZATION`
106-
107-
We also provide a few collections of dependencies:
101+
The full list (including their descriptions) is available here:
108102

109-
- `ALL` for installing the basic dependencies without extras
110-
- `FULL` for installing every dependency, including the extras
111103
- `RAY` for installing ray and its dependencies
112-
- `ZARR` for installing the zarr functionality for chunked timestamp saving/loading.
113-
- `DOCS` for developers, dependencies for building docs
114-
- `DEV` for developers, dependencies for testing and contributing
104+
- `ZARR` for installing the zarr functionality for chunked timestamp saving/loading
105+
- `FEATURES_EXTRA` for installing interpolation- and clustering-specific dependencies
106+
- `MASK_EXTRA` for installing `s2cloudless` for cloud masking
107+
- `VISUALIZATION` for using plotting libraries and utilities
108+
- `FULL` for installing all dependencies described so far
109+
- `DOCS` for developers, dependencies for building documentation
110+
- `DEV` for developers, dependencies for testing and code contribution
115111

116112
### Conda Forge distribution
117113

0 commit comments

Comments
 (0)