{"id":46467266,"url":"https://github.com/cssr-tools/pymm","last_synced_at":"2026-03-06T05:01:29.367Z","repository":{"id":222880740,"uuid":"758615540","full_name":"cssr-tools/pymm","owner":"cssr-tools","description":"Open-source image-based framework for computational fluid dynamics on microsystems","archived":false,"fork":false,"pushed_at":"2025-11-03T16:50:24.000Z","size":92305,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-03T18:32:40.744Z","etag":null,"topics":["cfd","gmsh","microsystems","navier-stokes","openfoam","python"],"latest_commit_sha":null,"homepage":"https://cssr-tools.github.io/pymm/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cssr-tools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-02-16T17:42:42.000Z","updated_at":"2025-11-03T16:50:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"6ee95296-5d1e-4978-bc1c-9b3a63e8d341","html_url":"https://github.com/cssr-tools/pymm","commit_stats":null,"previous_names":["cssr-tools/pymm"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/cssr-tools/pymm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssr-tools%2Fpymm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssr-tools%2Fpymm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssr-tools%2Fpymm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssr-tools%2Fpymm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cssr-tools","download_url":"https://codeload.github.com/cssr-tools/pymm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssr-tools%2Fpymm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30162716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T04:43:31.446Z","status":"ssl_error","status_checked_at":"2026-03-06T04:40:30.133Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cfd","gmsh","microsystems","navier-stokes","openfoam","python"],"created_at":"2026-03-06T05:00:26.603Z","updated_at":"2026-03-06T05:01:29.360Z","avatar_url":"https://github.com/cssr-tools.png","language":"Python","readme":"[![Build Status](https://github.com/cssr-tools/pymm/actions/workflows/CI.yml/badge.svg)](https://github.com/cssr-tools/pymm/actions/workflows/CI.yml)\n\u003ca href=\"https://www.python.org/\"\u003e\u003cimg src=\"https://img.shields.io/badge/python-3.12%20to%203.13-blue.svg\"\u003e\u003c/a\u003e\n[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8430989.svg)](https://doi.org/10.5281/zenodo.8430989)\n\n# pymm: An open-source image-based framework for CFD in microsystems \n\n\u003cimg src=\"docs/text/figs/pymm.gif\" width=\"830\" height=\"700\"\u003e\n\n## Main feature\nCreation of [_OpenFOAM_](https://www.openfoam.com) simulation models from given input images using [_Gmsh_](https://gmsh.info).\n\n## Installation\nYou will first need to install\n* OpenFOAM (https://www.openfoam.com) (tested with OpenFOAM-13)\n* Gmsh (https://gmsh.info) (tested with Gmsh 4.15.0)\n\nTo install the _pymm_ executable from the development version: \n\n```bash\npip install git+https://github.com/cssr-tools/pymm.git\n```\n\nIf you are interested in a specific version (e.g., v2025.10) or in modifying the source code, then you can clone the repository and install the Python requirements in a virtual environment with the following commands:\n\n```bash\n# Clone the repo\ngit clone https://github.com/cssr-tools/pymm.git\n# Get inside the folder\ncd pymm\n# For a specific version (e.g., v2025.10), or skip this step (i.e., edge version)\ngit checkout v2025.10\n# Create virtual environment (to specific Python, python3.12 -m venv vpycopm)\npython3 -m venv vpymm\n# Activate virtual environment\nsource vpymm/bin/activate\n# Upgrade pip, setuptools, and wheel\npip install --upgrade pip setuptools wheel\n# Install the pymm package\npip install -e .\n# For contributions/testing/linting, install the dev-requirements\npip install -r dev-requirements.txt\n```\n\nSee the [_OpenFOAM page_](https://openfoam.org/download/13-ubuntu/), where from OpenFOAM-12 the simulator is available via apt get, and OpenFOAM-13 is the latest release. \n\n## Running pymm\nYou can run _pymm_ as a single command line:\n```\npymm -i input_image.png -p input_parameters.toml -o output_folder\n```\nRun `pymm --help` to see all possible command line argument options. Inside the `input_parameters.toml` file you provide the framework parameters such as the dimensions of the microsystem, mesh size, inlet pressure, and more. See the .toml files in the [_examples_](https://github.com/cssr-tools/pymm/tree/main/examples) and [_tests_](https://github.com/cssr-tools/pymm/tree/main/tests/configs) folders.\n\n## Getting started\nSee the [_examples_](https://cssr-tools.github.io/pymm/examples.html) in the [_documentation_](https://cssr-tools.github.io/pymm/introduction.html).\n\n## Citing\n* Landa-Marbán, D. 2023. pymm: An open-source image-based framework for CFD in microsystems. https://doi.org/10.5281/zenodo.8430988.\n\n## Journal papers using pymm\nThe following is a list of journal papers in which _pymm_ is used:\n\n1. Liu, N., Haugen, M., Benali, B., Landa-Marbán, D., Fernø, M.A., 2023. Pore-scale spatiotemporal dynamics of microbial-induced calcium carbonate growth and distribution in porous media.  Int. J. Greenh. Gas Control 125, 103885. https://doi.org/10.1016/j.ijggc.2023.103885\n1. Liu, N., Haugen, M., Benali, B., Landa-Marbán, D., Fernø, M.A., 2023. Pore-scale kinetics of calcium dissolution and secondary precipitation during geological carbon storage. Chem. Geol. 641, 121782. https://doi.org/10.1016/j.chemgeo.2023.121782.\n\n## About pymm\n_pymm_, an image-based Python package for computational fluid dynamics, is funded by [_Center for Sustainable Subsurface Resources_](https://cssr.no) [project no. 331841] and [_NORCE Research As_](https://www.norceresearch.no) [project number 101070]. \nContributions are more than welcome using the fork and pull request approach.\nFor a new feature, please request this by raising an issue.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcssr-tools%2Fpymm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcssr-tools%2Fpymm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcssr-tools%2Fpymm/lists"}