Skip to content

Commit

Permalink
Mention conda installation in README
Browse files Browse the repository at this point in the history
  • Loading branch information
omad committed Aug 7, 2023
1 parent 39c4d30 commit a543804
Showing 1 changed file with 98 additions and 93 deletions.
191 changes: 98 additions & 93 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ Full list of libraries, and install instructions:
Installation
============


Libraries and applications in this repository are published to PyPI, and can be installed \
with `pip` like so:

Expand All @@ -48,103 +47,17 @@ pip install \
For Conda Users
---------------

`odc-tools` aren't available as conda packages, but the most
dependencies can be installed with conda from `conda-forge` channel.

Use `conda env update -f <file>` to install all needed dependencies for
`odc-tools` libraries and apps.

<details><summary>Conda `environment.yaml` (click to expand)</summary><div markdown="1">

```yaml
channels:
- conda-forge
dependencies:
# Datacube
- datacube>=1.8.5

# odc.dscache
- python-lmdb
- zstandard

# odc.algo
- dask-image
- numexpr
- scikit-image
- scipy
- toolz

# odc.ui
- ipywidgets
- ipyleaflet
- tqdm

# odc-apps-dc-tools
- pystac>=1
- pystac-client>=0.2.0
- azure-storage-blob
- fsspec
- lxml # needed for thredds-crawler

# odc.{aio,aws}: aiobotocore/boto3
# pin aiobotocore for easier resolution of dependencies
- aiobotocore==1.3.3
- boto3

# eodatasets3 (used by odc-stats)
- boltons
- ciso8601
- python-rapidjson
- requests-cache
- ruamel.yaml
- structlog
- url-normalize

# for dev
- pylint
- autopep8
- flake8
- isort
- black
- mypy

# For tests
- pytest
- pytest-httpserver
- pytest-cov
- pytest-timeout
- moto
- deepdiff

- pip>=20
- pip:
# odc.apps.dc-tools
- thredds-crawler

# odc.stats
- eodatasets3

# tests
- pytest-depends
Some **odc-tools** are available via `conda` from the `conda-forge` channel.

# odc.ui
- jupyter-ui-poll

# odc-tools libs
- odc-stac
- odc-algo
- odc-ui
- odc-dscache
- odc-stats
```
conda install -c conda-forge odc-apps-dc-tools odc-algo odc-io odc-cloud
# odc-tools CLI apps
- odc-apps-cloud
- odc-apps-dc-tools
```
</div></details>

CLI Tools
=========

Cloud Tools
===========

Installation
------------
Expand Down Expand Up @@ -252,6 +165,98 @@ libs apps
conda env remove -n odc-tests-py38
```

Use `conda env update -f <file>` to install all needed dependencies for
`odc-tools` libraries and apps.

<details><summary>Conda `environment.yaml` (click to expand)</summary><div markdown="1">

```yaml
channels:
- conda-forge
dependencies:
# Datacube
- datacube>=1.8.5

# odc.dscache
- python-lmdb
- zstandard

# odc.algo
- dask-image
- numexpr
- scikit-image
- scipy
- toolz

# odc.ui
- ipywidgets
- ipyleaflet
- tqdm

# odc-apps-dc-tools
- pystac>=1
- pystac-client>=0.2.0
- azure-storage-blob
- fsspec
- lxml # needed for thredds-crawler

# odc.{aio,aws}: aiobotocore/boto3
# pin aiobotocore for easier resolution of dependencies
- aiobotocore==1.3.3
- boto3

# eodatasets3 (used by odc-stats)
- boltons
- ciso8601
- python-rapidjson
- requests-cache
- ruamel.yaml
- structlog
- url-normalize

# for dev
- pylint
- autopep8
- flake8
- isort
- black
- mypy

# For tests
- pytest
- pytest-httpserver
- pytest-cov
- pytest-timeout
- moto
- deepdiff

- pip>=20
- pip:
# odc.apps.dc-tools
- thredds-crawler

# odc.stats
- eodatasets3

# tests
- pytest-depends

# odc.ui
- jupyter-ui-poll

# odc-tools libs
- odc-stac
- odc-algo
- odc-ui
- odc-dscache
- odc-stats

# odc-tools CLI apps
- odc-apps-cloud
- odc-apps-dc-tools
```
</div></details>
Release Process
===============
Expand Down

0 comments on commit a543804

Please sign in to comment.