An open API service indexing awesome lists of open source software.

https://github.com/wekeo/multicloud

This repository contains all code and resources relevant for demonstrations of multi-cloud exploitation of EUMETSAT data.
https://github.com/wekeo/multicloud

atmospheric-composition cloud-computing copernicus data-proximate-computing earth-observation eumetsat jupyter-notebook marine python

Last synced: 5 months ago
JSON representation

This repository contains all code and resources relevant for demonstrations of multi-cloud exploitation of EUMETSAT data.

Awesome Lists containing this project

README

          

# Multicloud

[![Python](https://img.shields.io/badge/python-anaconda-blue)](https://www.anaconda.com/products/distribution)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.txt)

The **multicloud** module consists of a collection of python-based Jupyter-notebooks
design to demonstrate the exploitation of Copernicus Marine and Atmospheric Composition
products in a multicloud environment using a data-proximate computing strategy.

For any questions about this repository, please contact ops@eumetsat.int.

## License

This code is licensed under an MIT license. See file LICENSE.txt for details on
the usage and distribution terms. No dependencies are distributed as part of this
package. Copyright EUMETSAT 2023.

All product names, logos, and brands are property of their respective owners.
All company, product and service names used in this website are for identification
purposes only.

## Authors

* [**Ben Loveday**](mailto://ops@eumetsat.int) - [EUMETSAT](http://www.eumetsat.int)
* [**Hayley Evers-King**](mailto://ops@eumetsat.int) - [EUMETSAT](http://www.eumetsat.int)
* [**Anna-Lena Erdmann**](mailto://ops@eumetsat.int) - [EUMETSAT](http://www.eumetsat.int)
* [**Julia Wagemann**](mailto://ops@eumetsat.int) - [EUMETSAT](http://www.eumetsat.int)
* [**Mike Grant**](mailto://ops@eumetsat.int) - [EUMETSAT](http://www.eumetsat.int)
* [**Armagan Karatosun**](mailto://armagan.karatosun@ecmwf.int) - [ECMWF](http://www.ecmwf.int)

Please see the AUTHORS.txt file for more information on contributors.

## Prerequisites

You will require `Jupyter Notebook` to run this code. We recommend that you install
the latest [Anaconda Python distribution](https://www.anaconda.com/) for your
operating system. Anaconda Python distributions include Jupyter Notebook.

## Dependencies

|item|version|licence|package info|
|---|---|---|---|
|libmamba|1.5.1|BSD-3|https://anaconda.org/conda-forge/libmamba|
|python|3.9.16|PSF|https://docs.python.org/3/license.html|
|jupyterlab|4.0.3|BSD-3|https://anaconda.org/conda-forge/jupyterlab|
|xarray|2023.7.0|Apache-2.0|https://anaconda.org/conda-forge/xarray|
|rioxarray|0.15.0|Apache-2.0|https://anaconda.org/conda-forge/rioxarray|
|dask|2023.7.1|BSD-3|https://anaconda.org/conda-forge/dask|
|distributed|2022.12|BSD-3|https://anaconda.org/conda-forge/distributed|
|netcdf4|1.6.4|MIT|https://anaconda.org/conda-forge/netcdf4|
|zarr|2.16.1|MIT|https://anaconda.org/conda-forge/zarr|
|s3fs|2023.9.2|BSD-3|https://anaconda.org/conda-forge/s3fs|
|matplotlib|3.8.0|PSF-2.0|https://anaconda.org/conda-forge/matplotlib|
|intake|0.7.0|BSD-2|https://anaconda.org/conda-forge/intake-xarray|
|intake-xarray|0.7.0|BSD-2|https://anaconda.org/conda-forge/intake-xarray|
|pydap|3.4.0|MIT|https://anaconda.org/conda-forge/pydap|
|rasterio|1.3.9|BSD-3|https://anaconda.org/conda-forge/rasterio|
|ipywidgets|8.1.1|BSD-3|https://anaconda.org/conda-forge/ipywidgets|
|boto3|1.28.17|Apache-2.0|https://anaconda.org/conda-forge/boto3|
|cartopy|0.22.0|LGPL-3.0|https://anaconda.org/conda-forge/cartopy|
|geopandas|0.14.0|BSD-3|https://anaconda.org/conda-forge/geopandas|
|botocore|1.31.17|Apache-2.0|https://anaconda.org/conda-forge/botocore|
|pip|23.3.1|MIT|https://anaconda.org/conda-forge/pip|
|xmwh|0.9.3|Apache-2.0|https://github.com/coecms/xmhw|
|dask-worker-pools|0.1.0|MIT|https://github.com/gjoseph92/dask-worker-pools|

## Installation

The simplest and best way to install these packages is via Git. Users can clone this
repository by running the following commands from either their [terminal](https://tinyurl.com/2s44595a)
(on Linux/OSx), or from the [Anaconda prompt](https://docs.anaconda.com/anaconda/user-guide/getting-started/).

You can usually find your terminal in the start menu of most Linux distributions
and in the Applications/Utilities folder on OSx. Alternatively, you should be
able to find/open your Anaconda prompt from your start menu (or dock, or via running
the Anaconda Navigator). Once you have opened a terminal/prompt, you should navigate
to the directory where you want to put the code. Once you are in the correct directory,
you should run the following command;

`git clone --recurse-submodules --remote-submodules https://github.com/wekeo/multicloud.git`

This will make a local copy of all the relevant files.

*Note: If you find that you are missing packages, you should check that you ran
`git clone` with both the `--recurse-submodules` and `--remote-submodules` options.*

*Note: if you are using an older version of git, you may find that your submodules are empty. In this case, you need to remove the folder and re-run the line above with `--recursive` added to the end*

## Usage

This collection supports Python 3.9. Although many options are possible, the
authors highly recommend that users install the appropriate Anaconda package
for their operating system. In order to ensure that you have all the required
dependencies, we recommend that you build a suitable Python environment, as
discussed below.

### Python environments

Python allows users to create specific environments that suit their applications.
This tutorials included in this collection require a number of non-standard
packages - e.g. those that are not included by default in Anaconda. In this
directory, users will find a *environment.yaml* file which can be used to
construct an environment that will install all the required packages.

To construct the environment, you should open either **terminal** (Linux/OSx)
or an **Anaconda prompt** window and navigate to repository folder you downloaded
in the **Installation** section above. In this folder there is a file called
**environment.yml**. This contains all the information we need to install the relevant
packages.

To create the environment, run:

`conda install -n base conda-libmamba-solver`

`conda env create -f environment.yml --solver=libmamba`

This will create a Python environment called **multicloud**. The environment
won't be activated by default. To activate it, run:

`conda activate multicloud`

We also need to install a single package using pip. For this, you should run the following command:

`python -m pip install git+https://github.com/gjoseph92/dask-worker-pools.git@main`

Now you are ready to go!

*Note: remember that you may need to reactivate the environment in every
new window instance*

### Running Jupyter Notebook

This module is based around a series of [Jupyter Notebooks](https://jupyter.org/). These support high-level interactive learning by allowing us to combine code, text description and data visualisations. If you have not worked with `Jupyter Notebooks`
before, please look at the [Introduction to Python and Project Jupyter](./working-with-python/Intro_to_Python_and_Jupyter.ipynb) module to get a short introduction to their usage and benefits.

To run Jupyter Notebook, open a terminal or Anaconda prompt and make sure you have activated
the correct environment. Again, navigate to the repository folder. Now you can run Jupyter using:

`jupyter lab` or `jupyter-lab`, depending on your operating system.

This should open Jupyter Notebooks in a browser window. On occasion, Jupyter may not
be able to open a window and will give you a URL to past in your browser. Please do
so, if required.

*Note: Jupyter Notebook is not able to find modules that are 'above' it in a directory
tree, and you will unable to navigate to these. So make sure you run the line above
from the correct directory!*

Now you can run the notebooks! We recommend you start with the [Index](./Index.ipynb) module.

### Collaborating, contributing and issues

If you would like to collaborate on a part of this code base or contribute to it
please contact us on copernicus.training@eumetsat.int. If you are have issues and
need help, or you have found something that doesn't work, then please contact us
at ops@eumetsat.int. We welcome your feedback!