pyOFTools

KO | EN

gitlite — search

#ai #typescript #go #machine-learning #rust #nodejs #macos #java #cli #awesome-list #pytorch #ios #mcp #openai

(★ 12)

No description available.

pyOFTools Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://henningscheufler.github.io/pyOFTools/)
[![CI](https://github.com/HenningScheufler/pyOFTools/actions/workflows/ci.yaml/badge.svg)](https://github.com/HenningScheufler/pyOFTools/actions/workflows/ci.yaml)
[![Codecov](https://codecov.io/gh/HenningScheufler/pyOFTools/branch/main/graph/badge.svg)](https://codecov.io/gh/HenningScheufler/pyOFTools)

# pyOFTools

Python tools and utilities for OpenFOAM

Currently in the pre-alpha release state.

## Description

pyOFTools is a collection of Python utilities for working with OpenFOAM simulations. It provides:

- Region selection and geometry tools
- Field manipulation functions
- Post-processing utilities
- Time series analysis
- Dictionary handling

## Installation

### Prerequisites

- Python 3.8 or higher
- OpenFOAM of2012 or higher (for OpenFOAM integration features)
- Required Python packages: numpy, pydantic

### Install from PyPI (when available)

```bash
pip install pyOFTools
```

### Install from source

```bash
git clone https://github.com/HenningScheufler/pyOFTools
cd pyOFTools
pip install -e .
```

### Development installation

```bash
git clone https://github.com/HenningScheufler/pyOFTools
cd pyOFTools
pip install -e ".[dev]"
```

## Usage

```python
import pyOFTools

# Use region selection tools
from pyOFTools import Box, Sphere

# Create geometric regions
box = Box(min=(0, 0, 0), max=(1, 1, 1))
sphere = Sphere(center=(0.5, 0.5, 0.5), radius=0.3)

# Combine regions
region = box & sphere  # intersection
```

## OpenFOAM Integration

The project also includes CMake build system for embedding Python into OpenFOAM as function objects. The CMake build is separate from the Python package installation.

## Testing

Run the test suite:

```bash
pytest
```

## Documentation

Documentation can be found [here](https://henningscheufler.github.io/pyOFTools/).

## License

GPL-3.0-or-later

pyOFTools

pyOFTools Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

pyOFTools

pyOFTools Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README