# 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](LICENSE.md) file for more details.