pyteseo 0.0.7

Package under development!

pyTESEO is a python package developed by IHCantabria to simplify and facilitate the setup and processing of TESEO simulations (TESEO is a lagrangian numerical model also developed by IHCantabria.)

💻 Installation

1. Install pyTESEO library:

   Pip package manager is needed to install the library and it is recommended to be installed from [IHCantabria/pyteseo](https://github.com/IHCantabria/ pyteseo) repository:

   pip install git+https://github.com/IHCantabria/pyteseo
   

   Alternatively, you can install it from pypi but you will need also install some direct dependencies that are not publish in pipy repositories:

   pip install pyteseo
   
   # direct dependencies:
   pip install "datahub @ https://github.com/IHCantabria/datahub.client/archive/refs/tags/v0.9.4.zip"
   

2. Install TESEO model binary (Not available yet!):

   • Get access to the binary @ (https://github.com/IHCantabria/TESEO/blob/main/bin)

   • Set up environment variable "TESEO_PATH" with the path to the model executable. You can use the command following CLI command after activate the python environement (python-dotenv library)

         dotenv set TESEO_PATH /path/to/teseo_executable
     

3. Online data providers require to stablish opendap connections, and in some cases aditional configurations:

   • CMEMS products 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
     

   • IHCantabria products requires connection to IHCantabria datahub API. You should set up the environment variable DATAHUB_API_URL.

     DATAHUB_API_URL = "https://datahub.ihcantabria.com"
     

✔️ Tests

Tests are located in pyteseo/tests/ and data required for tests are located in pyteseo/tests/data/. Tests have been developed using pytest.

Run tests to verify your package installation:

pyteseo-test        # Run tests and prompt pytest-report

♻️ Continuous integration (CI)

• Build and deploy documentation on Github Pages in .github/workflows/docs.yml
• Install and test package in diferent environments in .github/workflows/tests.yml
• Precommit hooks for formats and linting in .pre-commit-config.yaml

For Linux, Windows, MacOS and compatible python versions defined in installation section

📚 Documentation

Documentation is available at https://ihcantabria.github.io/pyteseo

©️ Credits

Developed and maintained by 👨‍💻 German Aragon @ 🏢 IHCantabria.