Numerical tools for studying VIV models
Project description
VIVyd
Description
VIVyd is a Python package for simulating vortex-induced vibrations (VIV). It implements several models for the fluid-structure interaction.
Installation
The package will be available on PyPI in the near future, but for now, you can install it directly in development mode. See the Development setup section below for instructions.
Development setup
To get started with the source code of this project, clone this repository to your local machine.
git clone https://gitlab.uliege.be/structural-and-stochastic-dynamics/vivyd.git
Or, if you prefer using SSH:
git clone git@gitlab.uliege.be:structural-and-stochastic-dynamics/vivyd.git
Then, navigate into the project directory:
cd vivyd
Next, it's recommended to create a virtual environment to manage dependencies. In particular, this project uses uv for environment management. To synchronize the environment with the specified dependencies, simply run:
uv sync
Finally, you can install the package in editable mode to easily test and modify it:
uv pip install -e .
Usage
Examples of how to use the package can be found in the examples directory. You can run them using:
cd src/examples
uv run example_name.py
The package can also be imported in your own Python scripts or Jupyter notebooks.
Support
The best way to get help is to open an issue in the issue tracker of this repository.
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 tests for any new features or bug fixes.
License
This project is licensed under the MIT License. See the LICENSE.md file for more details.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vivyd-0.1.2.tar.gz.
File metadata
- Download URL: vivyd-0.1.2.tar.gz
- Upload date:
- Size: 1.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.9 {"installer":{"name":"uv","version":"0.9.9"},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
134640345189a49cfb4023b82d64ae1f336498e22cbe894804e806f47ec3c4f6
|
|
| MD5 |
ab9c1f86f30ba27d6b87600efdbb7670
|
|
| BLAKE2b-256 |
3d35404595cd031e40f448ee64996219cb99980952ca7d339fc3c9f3770f4ca9
|
File details
Details for the file vivyd-0.1.2-py3-none-any.whl.
File metadata
- Download URL: vivyd-0.1.2-py3-none-any.whl
- Upload date:
- Size: 12.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.9 {"installer":{"name":"uv","version":"0.9.9"},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
52b9583c456122df94cda84000a065de852bdcee05c5ea3c6012729339f7baeb
|
|
| MD5 |
d381fa163c604142101c6b7f7cbe4f03
|
|
| BLAKE2b-256 |
333f16e89bd6ef7152b589fde9401c55d968cf72fa6cc628adcd1d1121f4a3f0
|
