coclico-workbench
Welcome to the CoCliCo workbench! This is a prototype repository containing tutorials and exploratory tools for Coastal Climate Core Services. It enables expert users to conduct in-depth analyses using data available in the platform, either online or offline.
Coding online in Google Colab or Binder
Notebooks can be opened in Google Colab or in Binder
. The latter uses the
environment.yml file in the main directory.
Coding offline (locally) in the Workbench Environment
Please follow the instructions below to install the CoCliCo Workbench environment:
-
Install GitHub Desktop for your OS: https://desktop.github.com/
-
Install the Mamba Package Manager (miniforge3) for your OS: https://github.com/conda-forge/miniforge#mambaforge
-
Open a miniforge prompt (by searching "miniforge" in the task bar) and run
mamba –-versionto check if the installation was complete. -
Clone the
coclico-workbenchrepo by adding ("Add" --> "clone repository" --> "URL") the URL in GitHub Desktop, you can find the URL under the green "code" button in thiscoclico-workbenchrepo. Please change the local path to something like:C:\Users\***\Documents\GitHub(where you create the GitHub folder yourself). The repo will be cloned here. -
In the miniforge prompt, change the directory to the cloned repo by running
cd C:\Users\***\Documents\GitHub\coclico-workbench\coclicodata_env, where *** needs to be replaced to your system variables. -
This directory contains an
environment.ymlfile with all the necessary packages describing the software dependencies. Create the software environment (calledcoclico) by running the following command in the miniforge prompt (note, this will take about 10-15 minutes to run):mamba env create -f environment.yml
-
Now you can activate the environment we just created, in your miniforge prompt please run the following:
mamba activate coclico
-
You can look which environments you have installed by running:
mamba env list. It places a star to indicate in which environment you are situated now (also indicated in front of your command line). -
In principle, mamba should have installed the pip dependencies as well. If it fails to install these, you can install the ones requiring pip in the
environment.ymlfile manually by running (note list might not be complete, check against theenvironment.ymlfile):pip install stactools-geoparquet-items odc-ui odc-stac odc-stats odc-algo odc-io odc-cloud[ASYNC] mapbox mapboxcli xstac
-
To check if all went well you can run
mamba listto list all installed packages and search for, for instancemapbox. If it is present, you can continue. -
For running jupyter notebooks and / or python scripts, we recommend to install VS Code editor: https://code.visualstudio.com/ as it offers flexibility in selecting environments, directories and python interpreters as well as offers various useful extensions all in one user interface.
-
Open VS Code and select the cloned
coclico-workbenchfolder as your working directory. As a test, you can openIPCC_AR5_AR6_comparison.ipynbin notebooks. Select your kernel (thecoclicoenv) in the top right corner and run cells by pressing shift-enter. You should be able to progress through the notebook without any errors. -
Might you run into trouble with these installation guidelines, please reach out to @EtienneKras, @mathvansoest or @FlorisCalkoen for help.
Repository structure
-
exploratory_tools: Various notebooks that dive deep into user stories with very specific needs too detailed for the CoCliCo web platform; i.e. comparisons to High-Resolution data, aggregating information on different levels, etc.
-
tutorials: Short example notebooks describing how to configure and use the CoCliCo Data repository (STAC) for different data types (CoG, Zarr, Parquet).
-
src/coclico: Various scripts with basic functionalities that can be used for the tutorials & exploratory tools.
-
docs: MkDocs documentation for the CoCliCo Handbook.
-
coclicodata_env: Full .yml file for the offline (local) workbench environment, the other .yml file in the main directory will be used by Binder or Colab in the online environment.
Contributing
Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.
License
coclico is licensed under the terms of the GNU general public license.
Credits
coclico template was created with
cookiecutter and and
the py-pkgs-cookiecutter template.
Metadata
Release files for coclico 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| coclico-1.0.1.tar.gz | 27.8 MB | Without provenance | Details for coclico-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| coclico-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for coclico-1.0.1-py3-none-any.whl |
Total release size: 27.9 MB
Release files / coclico-1.0.1.tar.gz
| Download URL | coclico-1.0.1.tar.gz |
|---|---|
| Size | 27.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
207c357f7b4eb11b7a5663d29e4c11e1ddf7455820e95077d517dafcacc164a6
|
|
BLAKE2b-256 checksum How to use checksums |
12d16b74a169e1190765ebc4334b730a583a0a7d965578a558ac9bf70f3e21ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / coclico-1.0.1-py3-none-any.whl
| Download URL | coclico-1.0.1-py3-none-any.whl |
|---|---|
| Size | 21.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c521bbe7dd2243d69d02d9fb216f08a314654decbae8706e6c2b18a554baa2ed
|
|
BLAKE2b-256 checksum How to use checksums |
62edfcffad705c62b7578feb9176eccd0c5e0d9931cb33fb9085a020c28cfc73
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Security for coclico 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.