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.)
| Linux | MacOS | Windows | |
|---|---|---|---|
| Required python version | >= 3.7 | >= 3.7 | >= 3.8 |
- From
githubrepository usingpip:
pip install git+https://github.com/IHCantabria/pyteseo
# To install extra dev dependencies: pip install git+https://github.com/IHCantabria/pyteseo[dev]
# Using editable mode: pip install -e git+https://github.com/IHCantabria/pyteseo[dev]
UNDER DEVELOPMENT 🚧 - * From pypi using pip:
pip install pyteseoUNDER DEVELOPMENT 🚧 - * From conda-forge using conda:
conda install -c conda-forge pyteseoTests 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-reportIf 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- 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
Comprenhensive documentation is developed and mantained at https://ihcantabria.github.io/pyteseo
Documentation of all the package, usage and examples based on mockup input data are provided in Jupyter Notebooks format and ready to be used under Google Colab online platform.
Developed and maintained by 👨💻 German Aragon @ 🏢 IHCantabria.