Metadata-Version: 2.1
Name: ROMSOL
Version: 0.0.2
Summary: Python API for Fluid-solid interaction FEM simulations
Author-Email: Romain Degraeve <rom2graeve@gmail.com>, Eliot Deschang <eliot.deschang@gmail.com>
License: GPL-3.0+
Requires-Python: >=3.13
Requires-Dist: numpy>=2.4.4
Requires-Dist: numba>=0.65.0
Requires-Dist: scipy>=1.17.1
Requires-Dist: gmsh>=4.15.2
Requires-Dist: h5py>=3.16.0
Requires-Dist: matplotlib>=3.10.9
Requires-Dist: pyvista>=0.48.4
Description-Content-Type: text/markdown

# ROMSOL

A comsol-like python API.

## Installation

### PDM Installation

ROMSOL relies on the Python Development Master (PDM) for package management. 



#### UV Installation

UV is a modern Python package manager that provides a simple and efficient way to manage Python packages and environments. For example, different python intepreter can be installed through the commands:

```bash
uv python install 3.11 3.12 3.13
```

ThisPython API is developped under python 3.13, so with uv run:

```bash
uv python install 3.13
```

Then, to install PDM using UV, run the following command:

```bash
uv pip install pdm
```

#### PIPX Installation

To install PDM using pipx, run the following command:

```bash
pipx install pdm
```

Prefer `pipx` as it allows you to install Python applications in isolated environments, preventing conflicts between packages.

#### Verify PDM Installation

When the installation is complete, you can verify that PDM is installed correctly by running:

```bash
pdm --version
```

### ROMSOL Installation

To install ROMSOL for development purposes, use PDM to install it in editable mode. This allows you to make changes to the source code and have those changes reflected immediately without needing to reinstall the package. To do this, navigate to the directory where you have the ROMSOL source code and run:

```bash
pdm install -e .
```