pyteseo 0.0.6

Python package developed to simplify and facilitate the setup and processing of TESEO simulations (https://ihcantabria.com/en/specialized-software/teseo/)

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.)

---

:computer: Installation

1 - Install the python library using pip:

# From pypi repository
pip install pyteseo

# Or directly from github repository
pip install git+https://github.com/IHCantabria/pyteseo

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 - Opendap connection to some CMEMS products is available at the library pyteseo/connections/cmems.py but needs authetication through the following environement variables:

dotenv set CMEMS_username your_username_at_CMEMS

dotenv set CMEMS_password your_password_at_CMEMS

---

:heavy_check_mark: 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

If you have cloned the repository, you also can run coverage.py functionalities based on current pytproyect.toml configuration from your terminal command line interface:

# Commands should be executed from the root directory of the repo

coverage run        # For run tests and generate ".coverage" file
coverage report     # For prompt results from ".coverage" file
coverage html       # For generate html report on "htmlcov" folder

---

:recycle: 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

---

:books: Documentation

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

---

:copyright: Credits

Developed and maintained by :man_technologist: German Aragon @ :office: IHCantabria.

---