pyteseo 0.0.3

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

:warning: Package under development!

:soon: First usable version (v1.0.0) will be released soon!

---

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

From github repositorie using pip:

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]

:warning: UNDER DEVELOPMENT :construction: - From pypi:

pip install pyteseo

:warning: UNDER DEVELOPMENT :construction: - From conda-forge:

conda install -c conda-forge pyteseo 

---

:heavy_check_mark: Testing & Coverage

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)

:warning: UNDER DEVELOPMENT :construction:

• deploy documentation on github page -> github action :heavy_check_mark:
• pass format -> Balck :x:
• pass linter -> ? :x:
• pass tests -> pytest :x:
• make documentation -> sphinx :x:
• install and pass tests in different systems -> github actions :x:

For all the SO (Windows, Linux, Mac), and python versions (3.10) required!

---

:books: Documentation

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.

---

:copyright: Credits

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

---