awesome-foamlib

foamlib is a modern Python package that provides an elegant, streamlined interface for interacting with OpenFOAM. It's designed to make OpenFOAM-based workflows more accessible, reproducible, and precise for researchers and engineers.

An awesome list for foamlib with OpenFOAM tutorials using sphinx-gallery.

Features

• 📚 Curated list of foamlib resources
• 🎓 Interactive tutorials using sphinx-gallery
• 🚀 Modern Python packaging with uv
• 📖 Comprehensive documentation

Installation

Using uv (recommended)

# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone the repository
git clone https://github.com/tkoyama010/awesome-foamlib.git
cd awesome-foamlib

# Sync dependencies
uv sync

Using pip

pip install -e .

Development

This project uses uv for fast, modern Python package management.

Setup development environment

# Sync all dependencies including dev dependencies
uv sync

# Run tests (after test files are created)
uv run pytest

# Build documentation (after setting up docs/ directory with Sphinx configuration)
# cd docs
# uv run make html

Project Structure

awesome-foamlib/
├── src/
│   └── awesome_foamlib/    # Main package
├── docs/                    # Documentation (future)
├── examples/                # Tutorial examples (future)
├── pyproject.toml          # Project configuration
└── README.md

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the GNU General Public License v3 - see the LICENSE file for details.

Copyright (C) 2025 Tetsuo Koyama

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Related Projects

• foamlib - Python library for OpenFOAM
• OpenFOAM - Open source CFD software

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Tetsuo Koyama 🤔

All Contributors 📖

pre-commit.ci 👀

This project follows the all-contributors specification. Contributions of any kind welcome!