Skip to content

Document installing runner specific dependencies #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,26 @@ which makes sure that code changes will be reflected immediately in your virtual
without the need of (re)installing the project.


#### Additional dependencies related to runners for individual process testing

The individual process testing module of the test suite allows to pick
a specific process "runner" (see further for more documentation).
Some of these runners require additional optional dependencies to be installed in your virtual environment,
which can be done by providing an appropriate "extra" identifier in the `pip install` command:

- For the "dask" runner:
```bash
pip install -e .[dask]
```
- For the "vito" runner:
```bash
pip install -e .[vito] --extra-index-url https://artifactory.vgt.vito.be/api/pypi/python-openeo/simple
```

Note that it might be not possible to install both "dask" and "vito" extras
in the same environment because of conflicting dependency constraints.


## Running the test suite

The test suite at least requires an openEO backend URL to run against.
Expand Down Expand Up @@ -124,10 +144,12 @@ with currently one of the following options:
These tests will be marked as skipped.
- `dask`: Executes the tests directly via the [openEO Dask implementation](https://github.com/Open-EO/openeo-processes-dask) (as used by EODC, EURAC, and others)
- Requires [openeo_processes_dask](https://github.com/Open-EO/openeo-processes-dask) package being installed in test environment.
See installation instructions above for more practical info.
- Covers all implemented processes.
- `vito`: Executes the tests directly via the
[openEO Python Driver implementation](https://github.com/Open-EO/openeo-python-driver) (as used by CDSE, VITO/Terrascope, and others).
- Requires [openeo_driver](https://github.com/Open-EO/openeo-python-driver) package being installed in test environment.
See installation instructions above for more practical info.
- Only covers a subset of processes due to the underlying architecture of the back-end implementation.
In particular, it only covers the pure Python code paths, but not the PySpark related aspects.

Expand Down
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,14 @@ classifiers = [
]

[project.optional-dependencies]
Dask = [
dask = [
"openeo-pg-parser-networkx>=2023.11.0",
"openeo-processes-dask[implementations]>=2023.11.6,!=2024.1.1",
"joblib>=1.3.2", # extra dependency that is not properly declared in openeo-processes-dask https://github.com/Open-EO/openeo-processes-dask/issues/216
]
vito = [
"openeo_driver>=0.81.0.dev",
]

[tool.pytest.ini_options]
testpaths = [
Expand Down