Scalable One-stop Platform for Hydroelastic Things (SOPHT).

This repository corresponds to the development of flow-structure interaction simulator (2D and 3D) using immersed boundary method, while capturing Cosserat rod dynamics using pyelastica.

Below are steps of how to install sopht. We mainly use poetry to manage the project, although most of the important commands will be provided in Makefile.

1. Clone!

First create the fork repository and clone to your local machine.

2. Virtual python workspace: conda, pyenv, or venv.

We recommend using python version above 3.10.

conda create --name sopht-env
conda activate sopht-env
conda install pip

3. Setup poetry and dependencies!

make poetry-download
make install
make pre-commit-install

We ask that any publications which use SophT cite as following:

@software{yashraj_bhosale_2023_7658908,
  author       = {Yashraj Bhosale and
                  Arman Tekinalp and
                  Songyuan Cui and
                  Fan Kiat Chan and
                  Mattia Gazzola},
  title        = {{Scalable One-stop Platform for Hydroelastic Things 
                   (SOPHT)}},
  month        = feb,
  year         = 2023,
  publisher    = {Zenodo},
  version      = {v.0.0.1},
  doi          = {10.5281/zenodo.7658908},
  url          = {https://doi.org/10.5281/zenodo.7658908}
}