Skip to content

Commit

Permalink
Merge separate extras into a single one (#753)
Browse files Browse the repository at this point in the history
* avoid underscore in extras

* switch to single extra extra

---------

Co-authored-by: Ziga Luksic <[email protected]>
  • Loading branch information
Matic Lubej and zigaLuksic authored Sep 6, 2023
1 parent 5fbdbb8 commit d9dcffe
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 10 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,6 @@ shapely
fiona
```

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).

### PyPI distribution

`eo-learn` is available on PyPI and can be installed with:
Expand All @@ -94,16 +92,15 @@ pip install eo-learn
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.:

```bash
pip install "eo-learn[MASK_EXTRA]"
pip install "eo-learn[EXTRA]"
pip install "eo-learn[VISUALIZATION]"
```

The full list (including their descriptions) is available here:

- `RAY` for installing ray and its dependencies
- `ZARR` for installing the zarr functionality for chunked timestamp saving/loading
- `FEATURES_EXTRA` for installing interpolation- and clustering-specific dependencies
- `MASK_EXTRA` for installing `s2cloudless` for cloud masking
- `EXTRA` for installing interpolation- and clustering-specific dependencies, or for installing `s2cloudless` in cloud masking
- `VISUALIZATION` for using plotting libraries and utilities
- `FULL` for installing all dependencies described so far
- `DOCS` for developers, dependencies for building documentation
Expand Down
2 changes: 1 addition & 1 deletion eolearn/features/extra/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
A collection of EOTasks with non-standard dependencies. Use the extra `FEATURES_EXTRA` to install dependencies or
A collection of EOTasks with non-standard dependencies. Use the extra `[EXTRA]` to install dependencies or
install the module-specific dependencies by hand.
"""
2 changes: 1 addition & 1 deletion eolearn/mask/extra/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
A collection of EOTasks with non-standard dependencies. Use the extra `MASK_EXTRA` to install dependencies or
A collection of EOTasks with non-standard dependencies. Use the extra `[EXTRA]` to install dependencies or
install the module-specific dependencies by hand.
"""
5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,10 @@ dependencies = [

[project.optional-dependencies]

full = ["eo-learn[RAY,ZARR,FEATURES_EXTRA,MASK_EXTRA,VISUALIZATION]"]
full = ["eo-learn[RAY,ZARR,EXTRA,VISUALIZATION]"]
ray = ["ray[default]"]
zarr = ["s3fs", "zarr"]
features_extra = ["numba>=0.53.0", "scikit-learn", "scipy"]
mask_extra = ["s2cloudless"]
extra = ["numba>=0.53.0", "scikit-learn", "scipy", "s2cloudless"]
visualization = ["graphviz>=0.10.1", "jinja2", "matplotlib", "pygments"]
docs = [
"eo-learn[FULL]",
Expand Down

0 comments on commit d9dcffe

Please sign in to comment.