https://github.com/fankiat/sopht-mpi
MPI-supported Scalable One-stop Platform for Hydroelastic Things (SOPHT)
https://github.com/fankiat/sopht-mpi
computational-fluid-dynamics cosserat-rod-theory fluid-structure-interaction high-performance-computing immersed-boundary-method mpi-applications
Last synced: 10 months ago
JSON representation
MPI-supported Scalable One-stop Platform for Hydroelastic Things (SOPHT)
- Host: GitHub
- URL: https://github.com/fankiat/sopht-mpi
- Owner: fankiat
- License: mit
- Created: 2022-08-25T17:58:20.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-05-01T19:35:21.000Z (about 3 years ago)
- Last Synced: 2024-01-27T14:09:52.963Z (over 2 years ago)
- Topics: computational-fluid-dynamics, cosserat-rod-theory, fluid-structure-interaction, high-performance-computing, immersed-boundary-method, mpi-applications
- Language: Python
- Homepage:
- Size: 692 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SophT-MPI
[![CI][badge-CI]][link-CI] [![DOI][badge-doi]][link-doi]
Scalable One-stop Platform for Hydroelastic Things (SOPHT) MPI solver.
Python implementation of an elastohydrodynamic MPI solver, for resolving
flow-structure interaction of 3D mixed soft/rigid bodies in viscous flows.
## Installation
Below are steps of how to install `sopht-mpi`. 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`.
We recommend using python version above 3.10.
```bash
conda create --name sopht-mpi-env
conda activate sopht-mpi-env
conda install python==3.10
```
3. Install non-python dependencies, that include `MPI`, `hdf5-mpi`
and `fftw`. For `Ubuntu` you can use:
```bash
make install_non_python_modules_on_ubuntu
```
And for Mac-OS one can use
```bash
make install_non_python_modules_on_macos
```
**NOTE**: For cluster, optimised versions of the above modules are already
installed, and as such this step can be skipped, and the internal modules
should be loaded directly.
4. Setup [`poetry`](https://python-poetry.org) and `dependencies`!
```bash
make poetry-download
make install
make pre-commit-install
```
## Citation
We ask that any publications which use SophT-MPI cite as following:
```
@software{fan_kiat_chan_2023_7659153,
author = {Fan Kiat Chan and
Yashraj Bhosale},
title = {{Scalable One-stop Platform for Hydroelastic Things
(SOPHT) MPI solver}},
month = feb,
year = 2023,
publisher = {Zenodo},
version = {0.0.1},
doi = {10.5281/zenodo.7659153},
url = {https://doi.org/10.5281/zenodo.7659153}
}
```
[badge-doi]: https://zenodo.org/badge/DOI/10.5281/zenodo.7659153.svg
[badge-CI]: https://github.com/fankiat/sopht-mpi/workflows/CI/badge.svg
[link-doi]: https://doi.org/10.5281/zenodo.7659153
[link-CI]: https://github.com/fankiat/sopht-mpi/actions