Metadata-Version: 2.4
Name: vivyd
Version: 0.1.9
Summary: Numerical tools for studying VIV models
Author-email: Tom BERTRAND <tom.bertrand@uliege.be>, Vincent DENOËL <v.denoel@uliege.be>
License-Expression: MIT
Project-URL: repository, https://gitlab.uliege.be/structural-and-stochastic-dynamics/vivyd
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy>=1.24
Requires-Dist: quantities>=0.16.4
Requires-Dist: ssdpy
Requires-Dist: taichi>=1.7.2; python_full_version == "3.12.*"
Requires-Dist: zarr>=3.1.6
Requires-Dist: zenodo-get>=3.0.0
Provides-Extra: docs
Requires-Dist: pydata-sphinx-theme>=0.17.1; extra == "docs"
Requires-Dist: sphinx>=9.1.0; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5.2; extra == "docs"
Requires-Dist: sphinx-design>=0.7.0; extra == "docs"
Requires-Dist: sphinx-new-tab-link>=0.8.1; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex>=2.7.0; extra == "docs"
Dynamic: license-file

# VIVyD: Vortex-Induced Vibration Dynamics

[![PyPI](https://img.shields.io/pypi/v/vivyd?style=for-the-badge&logo=pypi&color=blue)](https://pypi.org/project/vivyd/)
![Python Version](https://img.shields.io/badge/Python-3.12%20%7C%203.13%20%7C%203.14-blue?style=for-the-badge&logo=python)
[![More from us](https://img.shields.io/badge/more-from%20us-orange?style=for-the-badge&logo=gitlab)](https://gitlab.uliege.be/structural-and-stochastic-dynamics)


VIVyD is a Python package for simulating vortex-induced vibrations (VIV). It implements several models for the fluid-structure interaction. The package is designed to be flexible and extensible, allowing users to easily add new models and features.

## Documentation

A complete documentation is available online, including installation instructions, usage examples, and API reference. You can access it by clicking the button below.

[![Docs](https://img.shields.io/badge/docs-readthedocs-lightgray?style=for-the-badge&logo=readthedocs)](https://vivyd.readthedocs.io)


## Support
The best way to get help is to open an issue in the issue tracker of this repository.

[![Ask for help](https://img.shields.io/badge/Ask%20for%20help-Open%20an%20issue-red?style=for-the-badge&logo=gitlab)](https://gitlab.uliege.be/structural-and-stochastic-dynamics/vivyd/-/issues/new)


## Contributing
This project is open to contributions. If you would like to contribute, please fork the repository and create a pull request with your changes. Make sure to follow the coding style and include unitary tests for any new features or bug fixes.

[![Contribute](https://img.shields.io/badge/Contribute-Open%20a%20pull%20request-yellow?style=for-the-badge&logo=gitlab)](https://gitlab.uliege.be/structural-and-stochastic-dynamics/vivyd/-/merge_requests/new)
[![Fork](https://img.shields.io/badge/Fork-repository-yellow?style=for-the-badge&logo=gitlab)](https://gitlab.uliege.be/structural-and-stochastic-dynamics/vivyd/-/forks/new)


## License
This project is licensed under the MIT License.

[![License](https://img.shields.io/badge/License-MIT-green?style=for-the-badge&logo=opensourceinitiative)](LICENSE.md)
