Metadata-Version: 2.4
Name: pybFoam
Version: 0.1.1
Summary: python bindings for OpenFOAM
Keywords: OpenFOAM,simulation,CFD
Author-Email: Henning Scheufler <henning.scheufler@dlr.de>
License-Expression: GPL-3.0-or-later
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Project-URL: Homepage, https://github.com/DLR-RY/pybFoam
Project-URL: Repository, https://github.com/DLR-RY/pybFoam.git
Project-URL: Issues, https://github.com/DLR-RY/pybFoam/issues
Requires-Python: >=3.8
Requires-Dist: numpy>=1.20
Requires-Dist: pybind11>=2.6.0
Requires-Dist: pydantic
Requires-Dist: pyyaml
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-xdist; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: cmake>=3.18; extra == "dev"
Requires-Dist: pybind11-stubgen>=2.5; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=4.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Provides-Extra: all
Requires-Dist: pybFoam[dev,docs]; extra == "all"
Description-Content-Type: text/markdown

# pybFoam

python bindings for OpenFOAM

currently in the pre-alpha release state


## Installation

requires OpenFOAM of2012 or higher sourced and installed and python 3.7+ (conda is highly recommended) 

```
./build-pybFoam.sh # will install conan zmq oftest
```
## Testsuite

oftest is automatically installed and is run with py.test

```
py.test
```

## Build Documentation (WIP)

The documentation is based on the [Jekyll Documentation Theme](https://idratherbewriting.com/documentation-theme-jekyll/)

```
cd docs
jekyll serve
```