{"id":29464525,"url":"https://github.com/kevin-tofu/scikit-topt","last_synced_at":"2026-04-09T03:33:23.218Z","repository":{"id":285315821,"uuid":"957674835","full_name":"kevin-tofu/scikit-topt","owner":"kevin-tofu","description":"Scikit Topology Optimization with Scipy Family","archived":false,"fork":false,"pushed_at":"2026-01-24T13:53:15.000Z","size":19328,"stargazers_count":8,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-03-28T10:52:28.096Z","etag":null,"topics":["fem","finite-element-analysis","mesh","mesh-based","scikit","scikit-fem","topology-optimization","unstructured","unstructured-meshes"],"latest_commit_sha":null,"homepage":"https://scikit-topt.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kevin-tofu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"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":"2025-03-30T23:16:39.000Z","updated_at":"2026-03-05T14:15:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"371b302a-0624-4500-90f5-9c24e46c3784","html_url":"https://github.com/kevin-tofu/scikit-topt","commit_stats":null,"previous_names":["kevin-tofu/scikit-topt"],"tags_count":48,"template":false,"template_full_name":null,"purl":"pkg:github/kevin-tofu/scikit-topt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevin-tofu%2Fscikit-topt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevin-tofu%2Fscikit-topt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevin-tofu%2Fscikit-topt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevin-tofu%2Fscikit-topt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevin-tofu","download_url":"https://codeload.github.com/kevin-tofu/scikit-topt/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevin-tofu%2Fscikit-topt/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31584608,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"online","status_checked_at":"2026-04-09T02:00:06.848Z","response_time":112,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["fem","finite-element-analysis","mesh","mesh-based","scikit","scikit-fem","topology-optimization","unstructured","unstructured-meshes"],"created_at":"2025-07-14T07:00:51.193Z","updated_at":"2026-04-09T03:33:23.213Z","avatar_url":"https://github.com/kevin-tofu.png","language":"Python","funding_links":[],"categories":["PDE Solver","Finite Elements"],"sub_categories":[],"readme":"[![PyPI version](https://img.shields.io/pypi/v/scikit-topt.svg?cacheSeconds=60)](https://pypi.org/project/scikit-topt/)\n[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![DOI](https://zenodo.org/badge/957674835.svg)](https://doi.org/10.5281/zenodo.15441499)\n[![status](https://joss.theoj.org/papers/25f8f5cdc6533084cf84d3b8583c96aa/status.svg)](https://joss.theoj.org/papers/25f8f5cdc6533084cf84d3b8583c96aa)\n[![Python Version](https://img.shields.io/pypi/pyversions/scikit-topt.svg)](https://pypi.org/project/scikit-topt/)\n[![PyPI Downloads](https://static.pepy.tech/badge/scikit-topt)](https://pepy.tech/projects/scikit-topt)\n![CI](https://github.com/kevin-tofu/scikit-topt/actions/workflows/python-tests.yml/badge.svg)\n![CI](https://github.com/kevin-tofu/scikit-topt/actions/workflows/sphinx.yml/badge.svg)\n\n\n# 🧠 Scikit Topt\n**A lightweight, flexible Python library for topology optimization built on top of Scikit Libraries**\n- [scipy](https://scipy.org/)\n- [scikit-fem](https://github.com/kinnala/scikit-fem)\n\n## Documentation\n[Scikit-Topt Documentation](https://scikit-topt.readthedocs.io/en/latest/)\n\n## Examples and Features\n### Example 1 : Single Load Condition\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://media.githubusercontent.com/media/kevin-tofu/scikit-topt/master/assets/ex-pull-down-0.gif\" alt=\"Optimization Process Pull-Down-0\" width=\"400\" style=\"margin-right: 20px;\"\u003e\n  \u003cimg src=\"https://media.githubusercontent.com/media/kevin-tofu/scikit-topt/master/assets/ex-pull-down-1.jpg\" alt=\"Optimization Process Pull-Down-1\" width=\"400\"\u003e\n\u003c/p\u003e\n\n### Example 2 : Multiple Load Condition\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://media.githubusercontent.com/media/kevin-tofu/scikit-topt/master/assets/ex-multi-load-condition.jpg\" alt=\"multi-load-condition\" width=\"400\" style=\"margin-right: 20px;\"\u003e\n  \u003cimg src=\"https://media.githubusercontent.com/media/kevin-tofu/scikit-topt/master/assets/ex-multi-load-v-50.jpg\" alt=\"multi-load-condition-distribution\" width=\"400\"\u003e\n\u003c/p\u003e\n\n### Example 3 : Heat Conduction\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://media.githubusercontent.com/media/kevin-tofu/scikit-topt/master/assets/ex-heat-conduction-cond.jpg\" alt=\"heat-conduction\" width=\"400\" style=\"margin-right: 20px;\"\u003e\n  \u003cimg src=\"https://media.githubusercontent.com/media/kevin-tofu/scikit-topt/master/assets/ex-heat-conduction-0.gif\" alt=\"heat-conduction\" width=\"400\" style=\"margin-right: 20px;\"\u003e\n\u003c/p\u003e\n\n### Progress Report\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://media.githubusercontent.com/media/kevin-tofu/scikit-topt/master/assets/ex-progress-report.jpg\" alt=\"multi-load-condition-progress\" width=\"600\"\u003e\n\u003c/p\u003e\n\n\n## Features\n To contribute to the open-source community and education—which I’ve always benefited from—I decided to start this project. \n \nThe currently supported features are as follows:\n- Coding with Python  \n- easy installation with pip/poetry\n- Implement FEA on unstructured mesh using scikit-fem\n- Structural Analysis / Heat Conduction Analysis\n- Topology optimization using the density method and its optimization algorithm\n  - Optimality Criteria (OC) Method  \n  - (Log-Space) Modified OC Method \n- able to handle multiple force condition\n- High-performance computation using sparse matrices with Scipy and PyAMG  \n- has a function to monitor the transition of parameters.\n\n## SetUp\n\nYou can install **Scikit-Topt** either via **pip** or **Poetry**.\n\n#### Supported Python Versions\n\nScikit-Topt supports **Python 3.10–3.13**:\n\n- **3.10–3.12** — fully supported and tested  \n- **3.13** — core topology optimization works normally,  \n  but **VTK-based features** (VTU export \u0026 image rendering using PyVista)  \n  are temporarily unavailable because VTK/PyVista do not yet provide wheels  \n  for Python 3.13.\n\nYou can still run the full optimization workflow on Python 3.13;  \nonly visualization-related features are restricted.\n\n\n**Choose one of the following methods:**\n\n### Using pip\n```bash\npip install scikit-topt\n```\n\n### Using poetry\n```bash\npoetry add scikit-topt\n```\n\n### Optional: Enable off-screen rendering\n\nIf you want to visualize the optimized density distribution with mesh as an image,\nyou need to enable off-screen rendering using a virtual display.\n\nOn Debian/Ubuntu:\n```bash\nsudo apt install xvfb libgl1-mesa-glx\n```\n\nCentOS / RHL\n```bash\nsudo yum install xvfb libgl1-mesa-glx\n```\n\n## Usage\n See examples in example directory and README.md.\n[README for Usage](https://github.com/kevin-tofu/scikit-topt/blob/joss-review/examples/README.md) \n[Examples](https://github.com/kevin-tofu/scikit-topt/tree/joss-review/examples/tutorial) \n\n## Algorithm for Optimization\nOptimization Algorithms and Techniques are briefly summarized here.  \n[Optimization Algorithms and Techniques](https://kevin-tofu.github.io/scikit-topt/optimization.html)\n\n\n## Contributing\n\nWe are happy to welcome any contributions to the library.\nYou can contribute in various ways:\n\n- Reporting bugs, opening pull requests, or starting discussions via [GitHub Issues](https://github.com/kevin-tofu/scikit-topt/issues)\n- Writing new [examples](https://github.com/kevin-tofu/scikit-topt/tree/joss-review/examples)\n- Improving the [tests](https://github.com/kevin-tofu/scikit-topt/tree/joss-review/tests)\n- Enhancing the documentation or code readability [doc](https://scikit-topt.readthedocs.io/en/latest/)\n\nBy contributing code to **Scikit-Topt**, you agree to release it under the [Apache 2.0 License](https://github.com/kevin-tofu/scikit-topt/tree/master/LICENSE).\n\n\n## Acknowledgements\n### Standing on the shoulders of proverbial giants\n This software does not exist in a vacuum.\nScikit-Topt is standing on the shoulders of proverbial giants. In particular, I want to thank the following projects for constituting the technical backbone of the project:\n - Scipy\n - Scikit-fem\n - PyAMG\n - Numba\n - MeshIO\n - Matplotlib\n - PyVista\n - Topology Optimization Community\n\n\n\n## 📖 Citation\n\nIf you use Scikit Topt in your research or software, please cite it as:\n\n```bibtex\n@article{Watanabe_Scikit-Topt_A_Python_2025,\nauthor = {Watanabe, Kohei},\ndoi = {10.21105/joss.09092},\njournal = {Journal of Open Source Software},\nnumber = {116},\ntitle = {{Scikit-Topt: A Python Library for Algorithm Development in Topology Optimization}},\nvolume = {10},\nyear = {2025}\n}\n```\n\n## ToDo\n- Set break point from the optimization loop\n- Add A feature to assign tags to nodes and cells\n- Add Level Set\n- Add other optimizers\n  - Evolutionary Algorithms\n  - MMA\n- Add Multiple BC Conditions\n- Add Unit Test\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevin-tofu%2Fscikit-topt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevin-tofu%2Fscikit-topt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevin-tofu%2Fscikit-topt/lists"}