Skip to content

Commit

Permalink
Improve set-up instructions for examples (#534)
Browse files Browse the repository at this point in the history
* Add pip install line for processes example set up instructions

* Add lithops-aws and lithops-gcp extras
  • Loading branch information
tomwhite authored Aug 4, 2024
1 parent 819f6c8 commit bfe25ec
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 3 deletions.
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Follow the instructions for setting up Cubed to run on your executor runtime:

| Executor | Cloud | Set up instructions |
|-----------|--------|------------------------------------------------|
| Processes | N/A | N/A |
| Processes | N/A | `pip install 'cubed[diagnostics]'` |
| Lithops | AWS | [lithops/aws/README.md](lithops/aws/README.md) |
| | Google | [lithops/gcp/README.md](lithops/gcp/README.md) |
| Modal | AWS | [modal/aws/README.md](modal/aws/README.md) |
Expand Down
2 changes: 1 addition & 1 deletion examples/lithops/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
```shell
conda create --name cubed-lithops-aws-examples -y python=3.11
conda activate cubed-lithops-aws-examples
pip install -r requirements.txt # use requirements file from same directory as this readme
pip install 'cubed[lithops-aws]'
```

2. Configure Lithops with an [AWS Lambda compute backend](https://lithops-cloud.github.io/docs/source/compute_config/aws_lambda.html), and an [AWS S3 storage backend](https://lithops-cloud.github.io/docs/source/storage_config/aws_s3.html).
Expand Down
2 changes: 1 addition & 1 deletion examples/lithops/gcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# from this directory
conda create --name cubed-lithops-gcp-examples -y python=3.11
conda activate cubed-lithops-gcp-examples
pip install -r requirements.txt # use requirements file from same directory as this readme
pip install 'cubed[lithops-gcp]'
```

2. Configure Lithops with a [Google Cloud Functions compute backend](https://lithops-cloud.github.io/docs/source/compute_config/gcp_functions.html#configuration), and a [Google Cloud Storage backend](https://lithops-cloud.github.io/docs/source/storage_config/gcp_storage.html#configuration).
Expand Down
10 changes: 10 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,16 @@ beam = ["apache-beam", "gcsfs"]
dask = ["dask"]
dask-distributed = ["distributed"]
lithops = ["lithops[aws] >= 2.7.0"]
lithops-aws = [
"cubed[diagnostics]",
"lithops[aws]",
"s3fs",
]
lithops-gcp = [
"cubed[diagnostics]",
"lithops[gcp]",
"gcsfs",
]
modal = [
"cubed[diagnostics]",
"modal-client",
Expand Down

0 comments on commit bfe25ec

Please sign in to comment.