/DestinE_ESA_GFTS

Global Fish Tracking Service - DestinE DESP Use Case

Primary LanguageHCLApache License 2.0Apache-2.0

Global Fish Tracking Service (GFTS)

A Destination Earth Platform use case.

GFTS Jupyter book

GFTS Jupyter Hub

Documentation

Documentation can be viewed at https://destination-earth.github.io/DestinE_ESA_GFTS.

Clone the github repository

To get a local copy of the GFTS repository, you can clone it on your local computer and/or server:

git clone https://github.com/destination-earth/DestinE_ESA_GFTS.git

Install and run DestinE_ESA_GFTS jupyter notebooks locally from source

Jupyter notebooks to showcase GFTS are in the docs folder and can be run after installing Python and the required packages listed in the .binder/environment.yml file.

Install Python

To install Python, we recommend to install conda or miniconda and then create a new conda environment using .binder/environment.yml:

conda env create -f environment.yml

Do not forget to switch to the gfts conda environment prior to executing any Jupyter notebooks or programs from the GFTS repository.

conda activate gfts

To deactivate the gfts environment:

conda deactivate

Start JupyerLab and run the Jupyter notebooks

Once all the required packages are installed, you can start JupyterLab and run the jupyter notebooks from the docs folder:

jupyter lab

Install and run DestinE_ESA_GFTS with containers

Before building the GFTS docker image, you would need to install docker.

Build docker container

Make sure you change directory to gfts-track-reconstruction/jupyterhub/images/user before executing the command below:

docker build -t gfts:latest .

Run GFTS from docker

docker run -p 7777:8888 -i -t gfts:latest jupyter lab --ip=0.0.0.0 --no-browser

Open your web browser and enter the following command:

http://127.0.0.1:7777/lab

Then you need to enter your token: it can be found at the bottom of the printout you got after running the docker run command given above.

Deploy GFTS Hub on the cloud

Instructions on how to build and deploy GFTS hub are described in ./gfts-track-reconstruction/jupyterhub/README.md.

The current Jupyterhub deployment is done on OVH cloud operator.

Contributions

Tho contribute to DestinE Open Source SW collections please refer to Rule of Participation

Code of Conduct

DestinE open source community abide to this Code of Conduct