Update readme (installation section) #740
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zigaLuksic
reviewed
Sep 5, 2023
zigaLuksic
reviewed
Sep 6, 2023
README.md
Outdated
Comment on lines
83
to
94
| This will install the package and all the default modules. Otherwise, if you're interested in a super light, core-only installation of `eo-learn`, then install it via: | ||
|
|
||
| ```bash | ||
| pip install eo-learn | ||
| # pip install "eo-learn[CORE]" # this does the same thing | ||
| ``` | ||
|
|
||
| In order to avoid heavy environments, it is possible to install various scopes of package dependencies. Dependencies for each of the subfolders above (or their extra dependencies) can be installed via e.g.: | ||
|
|
||
| ```bash | ||
| pip install "eo-learn[FEATURES]" | ||
| pip install "eo-learn[FEATURES_EXTRA]" |
There was a problem hiding this comment.
I would perhaps structure this differently. More in a way of:
"To better control your dependencies you can install just the core dependencies of eolearn with pip install eo-learn or you can customize, which modules you want operational by providing the corresponding extras, e.g. pip install eo-learn[IO, MASK] if you are only interested in the io and mask submodules.
And then i'd also have a list of all these subpackage extras and their extra extras? I feel like this is the place to have this information, we shouldn't expect users to rummage through our pyproject.toml
There was a problem hiding this comment.
updated and added the list
Co-authored-by: Žiga Lukšič <[email protected]>
zigaLuksic
reviewed
Sep 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.