🚀 Get started

Quickstart guide to use pyTESEO

💻 Installation

Install pyTESEO:

# Option 1 - from github url
pip install "git+https://github.com/IHCantabria/pyteseo.git@vX.X.X"

# # Option 2 - Clone to your local machine and install it
# git clone "git+https://github.com/IHCantabria/pyteseo.git@vX.X.X"
# cd pyteseo
# pip install "."

Setup TESEO:

Setup an environment variable to locate the executable file of TESEO numerical model in your machine (TESEO v1.2.8). You need to activate your python environement where pyteseo is installed and execute the following command:

dotenv set TESEO_PATH /path/to/teseo_executable

Setup online providers:

IHCantabria requires connection to IHCantabria datahub API and Geoserver. You should set up the environment variables IHC_DATAHUB_API_URL,IHC_GEOSERVER_URL and IHC_WFS_VERSION.

dotenv set DATAHUB_API_URL https://datahub.ihcantabria.com
dotenv set IHC_GEOSERVER_URL https://geoserver.ihcantabria.com/geoserver
dotenv set IHC_WFS_VERSION 2.0.0

CMEMS requires authentication. You should set up the environment variables CMEMS_username and CMEMS_password.

dotenv set CMEMS_username your_username_at_CMEMS
dotenv set CMEMS_password your_password_at_CMEMS

Verify your installation by running the pyteseo tests, you only have to activate your environment and run the following command in your terminal:

pyteseo-test        # Run tests and prompt pytest-report

🎯 Main functionalities

Use the DomainRequest to generate TESEO’s domain!
Use the SimulationRequest to generate a TESEO’s simulation!
Use the SimulationRequest to generate on-the-fly TESEO’s domain and a TESEO’s simulation!

🔌 Online providers

Online providers are defined in an internal JSON file, that registry is used to centralize the required metadata to fetch data to each provider. Look up the following summary table.

PROVIDER	TYPE	INFRAESTRUCTURE	SERVICE	Process
IHCantabria	Raster	Thredds (Mercurio)	Opendap	datahub + xarray
IHCantabria	Vectorial	Geoserver	Wfs	owslib + geopandas
CMEMS	Raster	CMEMS AWS s3	ARCO Zarr	CMEMS library + xarray
EMODNet	Raster	ERDAP server	Opendap	xarray
NOAA*	Raster	Thredds (Nomads)	Opendap	xarray
NOAA*	Raster	NOAA AWS s3	ARCO Zarr	xarray