Skip to main content
styro

The package manager for OpenFOAM

Simplify your OpenFOAM workflows with easy package installation, management, and distribution

CI Codecov PyPI Conda Version OpenFOAM

Ruff ty uv Publish Binaries Docker


✨ Why styro?

styro brings modern package management to the OpenFOAM ecosystem, making it easy to discover, install, and manage community-contributed packages. Whether you're a researcher, engineer, and/or developer, styro streamlines your workflow by eliminating manual compilation and dependency management.

🎯 Key benefits

  • 🚀 One-command installation - Install OpenFOAM packages with a single command
  • 🌎 Community-driven - Access packages from the OpenFOAM Package Index (OPI)
  • 🧩 Broad compatibility - Works seamlessly with OpenFOAM from openfoam.com and openfoam.org
  • 📦 Multiple sources - Install from OPI, local directories, or Git repositories
  • 🔄 Easy updates - Upgrade packages with automatic dependency resolution
  • 🛠️ Developer-friendly - Simple package testing, definition and distribution

▶️ Demo

Demo

📋 Requirements

styro works with OpenFOAM (from either openfoam.com or openfoam.org).

⏬ Installation

Choose any of the following methods:

  • With pip (requires Python 3.9 or later):

    pip install styro
    
  • With conda:

    conda install -c conda-forge styro
    
  • With Homebrew:

    brew install gerlero/openfoam/styro
    
  • Standalone binary (installs to $FOAM_USER_APPBIN):

    /bin/bash -c "$(curl https://raw.githubusercontent.com/gerlero/styro/main/install.sh)"
    
  • On GitHub Actions via setup-styro:

    - uses: gerlero/setup-styro@v1
    
  • Docker image:

    docker pull microfluidica/styro
    

🧑‍💻 Command reference

Command Description Example
⏬ styro install <packages> Install one or more packages styro install cfmesh
⬆️ styro install --upgrade <packages> Upgrade already installed packages styro install --upgrade cfmesh
🗑️ styro uninstall <packages> Remove installed packages styro uninstall cfmesh
🔍 styro freeze List all installed packages styro freeze
🔄 styro install --upgrade styro Upgrade styro itself (only for standalone installs) styro install --upgrade styro

📦 Package sources

✨ OpenFOAM Package Index (OPI)

styro automatically discovers packages from the community-maintained OpenFOAM Package Index.

styro install cfmesh

🖥️ Local packages

Install packages from your local filesystem:

styro install /path/to/my-custom-package

Pro tip: Add a metadata.json file to the package directory to customize installation behavior.

🌎 Git repositories

Install directly from any Git repository:

styro install https://github.com/username/my-openfoam-package.git

Just like local packages, add a metadata.json file to the repository root for custom installation settings.

🤝 Contributing

We welcome contributions! Here's how you can help:

Metadata

Release files for styro 0.1.40

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for styro 0.1.40
File Size Uploaded Provenance Actions
styro-0.1.40.tar.gz 29.2 kB Without provenance Details for styro-0.1.40.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for styro 0.1.40
File Interpreter ABI Platform Actions
styro-0.1.40-py3-none-any.whl Python 3 none any Details for styro-0.1.40-py3-none-any.whl

Total release size: 62.3 kB

Release files / styro-0.1.40.tar.gz

Download URL styro-0.1.40.tar.gz
Size 29.2 kB
Tags Source
SHA-256 checksum
How to use checksums
571b9910ef038512d06439f7870834fd76dbf402061f26f8b89f188f9add45c1
BLAKE2b-256 checksum
How to use checksums
0f831c32b9f489604e7178f67c7b898b45fa486d0ec28b68fabfa075385c1feb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / styro-0.1.40-py3-none-any.whl

Download URL styro-0.1.40-py3-none-any.whl
Size 33.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
eae6c73845945dea70bbfde3cd2942a46482cf0f6812e7c895e0a696f90dfce3
BLAKE2b-256 checksum
How to use checksums
594bf9ee580c165f91896d542e2170d03babb788752da234f19df30d97900035
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for styro 0.1.40

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.40 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page