📘 SemiDevKit Documentation Portal
Welcome to the official documentation portal for SemiDevKit —
an open educational toolkit covering the full semiconductor workflow:
🧪 Device Physics → 🧩 Compact Modeling (BSIM4) → 🔌 SPICE Analysis →
🔬 TCAD Exploration → 🏗 VLSI Physical Design Automation
This directory provides structured, versioned, and reproducible documentation
for all modules included in SemiDevKit.
🔗 Official Links
| 🌐 Language |
GitHub Pages |
GitHub Repository |
| 🇺🇸 English |
 |
 |
📁 Documentation Index
| No. |
Section |
Description |
| 01 |
📥 Installation |
Python, ngspice, required packages, optional tools (WSL2, Docker, VS Code) |
| 02 |
⚙️ Initial Setup |
Project setup, directory layout, venv creation, OS-specific guidance |
| 03 |
▶️ Usage Guide |
How to run each module: BSIM4 analyzers, TCAD playgrounds, Paramus, OpenLane-Lite |
| 04 |
📄 License |
Hybrid license model (code, documents, diagrams) |
| 05 |
🏗 OpenLane-Lite Usage |
Full documentation of the lightweight RTL → GDSII flow |
| 06 |
🧯 Troubleshooting |
Common issues and solutions across all modules |
| 07 |
❓ FAQ |
Frequently asked questions |
| 08 |
🗂 Directory Structure |
Explanation of the repository layout |
| 09 |
📘 Glossary |
Definitions of device modeling, TCAD, SPICE, VLSI terms |
| 10 |
🕒 Changelog |
Complete update and version history |
| 11 |
🤝 Contributing Guide |
Contribution rules, PR flow, coding policies |
| 12 |
🔐 Security Policy |
Responsible vulnerability disclosure |
🧭 How to Use This Documentation
- 🎓 Students
→ Start from 01 → 02 → 03 for a guided learning path
- 🧠 Researchers / Engineers
→ Jump directly to 03 (Usage) and 05 (OpenLane-Lite)
- 🛠 Contributors
→ See 11 (Contributing) and 12 (Security)
🔗 External Resources
| Resource |
Link |
| 🏠 Project Home |
https://samizo-aitl.github.io/SemiDevKit/ |
| 💻 GitHub Repository |
https://github.com/Samizo-AITL/SemiDevKit |
| 🐞 Issue Tracker |
https://github.com/Samizo-AITL/SemiDevKit/issues |
👤 Author
| Item |
Details |
| 👨🔬 Name |
Shinichi Samizo |
| 💻 GitHub |
Samizo-AITL |
📄 License
| Component |
License |
Notes |
| 💻 Source Code |
MIT License |
Free use / modification |
| 📄 Text Materials |
CC BY 4.0 / CC BY-SA 4.0 |
Attribution required |
| 🎨 Figures & Diagrams |
CC BY-NC 4.0 |
Non-commercial only |
| 🔗 External References |
Original license |
Proper citation required |
📌 This documentation is designed to function as both
an educational textbook and a practical engineering manual.