{"id":37073406,"url":"https://github.com/qcfd-lab/qlbm","last_synced_at":"2026-01-14T08:37:00.755Z","repository":{"id":257808449,"uuid":"850796601","full_name":"QCFD-Lab/qlbm","owner":"QCFD-Lab","description":"A software package for Quantum Lattice Boltzmann Methods","archived":false,"fork":false,"pushed_at":"2025-12-12T12:29:38.000Z","size":33853,"stargazers_count":21,"open_issues_count":8,"forks_count":8,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-12-12T22:14:52.255Z","etag":null,"topics":["computational-fluid-dynamics","lattice-boltzmann","lattice-gas","qiskit","quantum-computing"],"latest_commit_sha":null,"homepage":"https://qcfd-lab.github.io/qlbm/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/QCFD-Lab.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-09-01T19:55:44.000Z","updated_at":"2025-11-24T15:57:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"b4273102-223c-4666-bc60-1abc0088bfd5","html_url":"https://github.com/QCFD-Lab/qlbm","commit_stats":null,"previous_names":["qcfd-lab/qlbm"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/QCFD-Lab/qlbm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QCFD-Lab%2Fqlbm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QCFD-Lab%2Fqlbm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QCFD-Lab%2Fqlbm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QCFD-Lab%2Fqlbm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/QCFD-Lab","download_url":"https://codeload.github.com/QCFD-Lab/qlbm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QCFD-Lab%2Fqlbm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28414667,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T08:31:27.429Z","status":"ssl_error","status_checked_at":"2026-01-14T08:31:19.098Z","response_time":107,"last_error":"SSL_read: 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":["computational-fluid-dynamics","lattice-boltzmann","lattice-gas","qiskit","quantum-computing"],"created_at":"2026-01-14T08:37:00.197Z","updated_at":"2026-01-14T08:37:00.746Z","avatar_url":"https://github.com/QCFD-Lab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `qlbm`\n\n![GitHub License](https://img.shields.io/github/license/qcfd-lab/qlbm?color=%2300A6D6) ![GitHub top language](https://img.shields.io/github/languages/top/qcfd-lab/qlbm?color=%2300A6D6) ![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FQCFD-Lab%2Fqlbm%2Frefs%2Fheads%2Fdev%2Fpyproject.toml?color=%2300A6D6) ![PyPI - Version](https://img.shields.io/pypi/v/qlbm?color=%2300A6D6) ![GitHub commits since latest release](https://img.shields.io/github/commits-since/qcfd-lab/qlbm/latest?color=%2300A6D6) ![GitHub branch check runs](https://img.shields.io/github/check-runs/qcfd-lab/qlbm/main?color=%2300A6D6) \u003ca href=\"https://arxiv.org/abs/2411.19439\"\u003e![Static Badge](https://img.shields.io/badge/preprint-blue?style=flat\u0026label=arXiv\u0026color=%2300A6D6)\u003c/a\u003e\n\n`qlbm` is a package for the development, simulation, and analysis of **Q**uantum **L**attice **B**oltzmann **M**ethods.\n\n---\n\n`qlbm` is a rapidly evolving, research-oriented piece of software. It contains building blocks for constructing quantum circuits for quantum LBMs and connects these with quantum software infrastructure. `qlbm` is built with end-to-end development environment in mind, including:\n\n- Parsing human-readable `JSON` specifications for QLBMs\n- Constructing quantum circuits in [Qiskit](https://www.ibm.com/quantum/qiskit) that implement QLBMs\n- Compiling quantum circuits to quantum computer and simulator platforms with Qiskit and [Pytket](https://tket.quantinuum.com/api-docs/)\n- Simulating quantum circuits on classical hardware with Qiskit and [Qulacs](http://docs.qulacs.org/en/latest/)\n- Visualizing results in [Paraview](https://www.paraview.org/)\n- Analyzing the properties , scalability, and performance of quantum algorithms\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://qcfd-lab.github.io/qlbm/\"\u003e\n\u003cimg width=400 centered alt=\"Static Badge\" src=\"https://img.shields.io/badge/Documentation-00A6D6%20?style=flat\u0026logo=BookStack\u0026logoColor=%23FFFFFF\u0026logoSize=10\u0026label=Web\u0026color=%2300A6D6\u0026\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n## Install from source\n\nAlternatively, you can also install the latest version of `qlbm` by cloning the repository and installing from source as follows (again using Python 3.12 or 3.13):\n\n```bash\ngit clone git@github.com:QCFD-Lab/qlbm.git\ncd qlbm\npython -m venv qlbm-cpu-venv\nsource qlbm-cpu-venv/bin/activate\npip install --upgrade pip\npip install -e .[cpu,dev,docs]\n```\nIf you are using `zsh` you need to replace the last line by\n```\npip install -e .\\[cpu,dev,docs\\]\n```\n\nWe also provide a `make` script for this purpose, which will create the environment from scratch:\n\n```\nmake install-cpu\nsource qlbm-cpu-venv/bin/activate\n```\n\n## PyPI installation\n\n`qlbm` can also be installed through `pip`. We recommend the use of a Python 3.12 or 3.13 virtual environment:\n\n```bash\npython -m venv qlbm-cpu-venv\npip install --upgrade pip\npip install qlbm\n```\n\nNote that `qlbm` evolves quickly and it is likely that the GitHub repository contains new features that the PyPI installation does not. To get the latest developments, we recommend the source installation.\n\n## Container installation\n\nThere are also Docker container images in the `Docker` directory that can be used to install `qlbm` in a container environment. Due to how quickly the code base is evolving, we recommend using the CPU option for stability purposes.\n\n## Algorithms and Usage\n\n\nCurrently, `qlbm` supports two algorithms:\n - The Quantum Transport Method (Collisionless QLBM) described in [Efficient and fail-safe quantum algorithm for the transport equation](https://doi.org/10.1016/j.jcp.2024.112816) ([arXiv:2211.14269](https://arxiv.org/abs/2211.14269)) by M.A. Schalkers and M. Möller.\n - The Space-Time QLBM/QLGA described in [On the importance of data encoding in quantum Boltzmann methods](https://link.springer.com/article/10.1007/s11128-023-04216-6) by M.A. Schalkers and M. Möller and expanded in [Fully Quantum Lattice Gas Automata Building Blocks for Computational Basis State Encodings](https://arxiv.org/abs/2506.12662).\n - The Linear-encoding Quantum Lattice Gas Automata (LQLGA) described in [On quantum extensions of hydrodynamic lattice gas automata](https://www.mdpi.com/2410-3896/4/2/48) by P. Love and [Fully Quantum Lattice Gas Automata Building Blocks for Computational Basis State Encodings](https://arxiv.org/abs/2506.12662).\n\nThe `demos` directory contains several use cases for simulating and analyzing these algorithms. Each demo requires minimal setup once the virtual environment has been configured. Consult the `README.md` file in the `demos` directory for further details.\n\n\u003e **Note on visualization**: we rely on  Paraview for visualizing the flow field of the simulation. You can install Paraview from [this link](https://www.paraview.org/download/).\n\n## Configuration\n\n`qlbm` uses quantum circuits to simulate systems that users can specify in simple `JSON` configuration files. For instance, the following configuration describes a 2D system of 64x32 gridpoints, 4 discrete velocities per dimension, and with 3 solid objects placed in the fluid domain:\n\n```JSON\n{\n  \"lattice\": {\n    \"dim\": {\n      \"x\": 64,\n      \"y\": 32\n    },\n    \"velocities\": {\n      \"x\": 4,\n      \"y\": 4\n    }\n  },\n  \"geometry\": [\n    { \n      \"shape\": \"cuboid\",\n      \"x\": [18, 20],\n      \"y\": [6, 25],\n      \"boundary\": \"specular\"\n    },\n    {\n      \"shape\": \"cuboid\",\n      \"x\": [23, 25],\n      \"y\": [3, 17],\n      \"boundary\": \"bounceback\"\n    },\n    {\n      \"shape\": \"cuboid\",\n      \"x\": [28, 29],\n      \"y\": [16, 29],\n      \"boundary\": \"specular\"\n    }\n  ]\n}\n```\n\n## Citation\n\nAn open access peer-reviewed article describing `qlbm` is available [here](https://doi.org/10.1016/j.cpc.2025.109699). If you use `qlbm`, you can cite it as:\n\n```\n@article{georgescu2025qlbm,\ntitle = {qlbm – A quantum lattice Boltzmann software framework},\njournal = {Computer Physics Communications},\nvolume = {315},\npages = {109699},\nyear = {2025},\nissn = {0010-4655},\ndoi = {https://doi.org/10.1016/j.cpc.2025.109699},\nurl = {https://www.sciencedirect.com/science/article/pii/S0010465525002012},\nauthor = {C\\u{{a}}lin A. Georgescu and Merel A. Schalkers and Matthias M\\\"{o}ller},\n}\n```\n\n## Contact\n\nIn addition to opening issues, you can contact the developers of `qlbm` at `qcfd-EWI@tudelft.nl`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqcfd-lab%2Fqlbm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqcfd-lab%2Fqlbm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqcfd-lab%2Fqlbm/lists"}