Metadata-Version: 2.4
Name: sim-plugin-openfoam
Version: 0.1.0
Summary: OpenFOAM driver for sim.
Project-URL: Homepage, https://github.com/svd-ai-lab/sim-plugin-openfoam
Project-URL: Repository, https://github.com/svd-ai-lab/sim-plugin-openfoam
Project-URL: Issues, https://github.com/svd-ai-lab/sim-plugin-openfoam/issues
Author-email: Weiqi Ji <jiweiqi10@gmail.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27
Requires-Dist: sim-cli-core>=0.3
Provides-Extra: test
Requires-Dist: build>=1.0; extra == 'test'
Requires-Dist: pytest>=7; extra == 'test'
Description-Content-Type: text/markdown

# sim-plugin-openfoam

OpenFOAM driver for [sim-cli](https://github.com/svd-ai-lab/sim-cli),
distributed as a plugin via Python `entry_points`.

## Install

For agent projects, install sim-cli-core and the OpenFOAM plugin in the project
environment:

```powershell
uv init  # only if this is not already a uv project
uv add sim-cli-core sim-plugin-openfoam
uv run sim plugin sync-skills --target .agents/skills --copy
uv run sim check openfoam
uv run sim plugin doctor openfoam --deep
```

For Claude Code, sync the bundled skill to `.claude/skills` instead:

```powershell
uv run sim plugin sync-skills --target .claude/skills --copy
```

For a reproducible agent run, pin the PyPI package version:

```powershell
uv add sim-cli-core "sim-plugin-openfoam==0.1.0"
```

`uv run sim ...` runs sim from this project environment, so it sees this
project's plugins. Without uv, create and activate a venv, then install
`sim-cli-core` plus this plugin from PyPI with `python -m pip`.

## Development

```bash
git clone https://github.com/svd-ai-lab/sim-plugin-openfoam
cd sim-plugin-openfoam
uv sync
uv run pytest
```

## License

Apache-2.0.
