Skip to content

Commit 9c998b2

Browse files
author
Vadym Vikulin
authored
Update README.md
1 parent d2ac3d7 commit 9c998b2

1 file changed

Lines changed: 55 additions & 2 deletions

File tree

README.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,61 @@
1-
KiCad DIY Kit for gamma-ray spectrometer using a popular NaI(Tl) scintillator, SiPM and a Raspberry Pi Pico 2.
1+
# OpenGammaKit
2+
3+
**OpenGammaKit** is an open-source gamma spectrometer hardware platform, inspired by the excellent [Open-Gamma-Detector](https://github.com/OpenGammaProject/Open-Gamma-Detector). It takes the original schematic and redesigns the PCB using **KiCad** (originally designed in EasyEDA), making the project more accessible and modifiable for open hardware enthusiasts.
4+
5+
OpenGammaKit is designed to be affordable, reliable, and easy to integrate with embedded systems, mobile devices, or PCs—ideal for DIY nuclear instrumentation, educational labs, or citizen science.
6+
7+
---
8+
9+
## 🔧 Features
10+
11+
- ✅ Based on the **Open-Gamma-Detector** schematic
12+
- ✅ Complete redesign in **KiCad** with improved layout and routing
13+
- ✅ USB serial communication (compatible with Android 7.0+ and PCs)
14+
- ✅ Compatible with [OGK Inspector](https://github.com/vikulin/OGK-Inspector) Android app and firmware
15+
- ✅ Real-time gamma spectrum output and spectrometer integration
16+
- ✅ Works with scintillation detectors (e.g., CsI(Tl), NaI(Tl), etc.)
17+
- ✅ Open and editable source files for schematics and PCB
18+
19+
---
20+
21+
## 📂 Repository Contents
22+
23+
- `/docs/` – 3D render previews of the board, Bill of Materials(BOM), KiCad schematic and PCB files
24+
- `/kicad-libraries/` – KiCad libraries including a custom footprints
25+
26+
---
27+
28+
## 🧠 Companion Projects
29+
30+
- **OGK Inspector (Android App)**
31+
View spectra, calculate resolution, access terminal mode
32+
👉 [OGK-Inspector on GitHub](https://github.com/vikulin/OGK-Inspector)
33+
34+
- **OGK Firmware**
35+
USB serial interface firmware for supported microcontrollers
36+
👉 [OGK Firmware Repository](https://github.com/vikulin/OGK-Firmware)
37+
38+
---
39+
40+
## 📷 3D render previews of the boards
241

342
<p align="center">
443
<br>
544
<img alt="3d View of the detector board" title="3d View of the detector board" width="500px" src="docs/pcb-3dview-v0.1.1.png">
645
</p>
746

8-
### Inspired by https://github.com/OpenGammaProject/
47+
---
48+
49+
## 📜 License
50+
51+
This project is licensed under the **GNU General Public License v3.0**.
52+
See the [LICENSE](LICENSE) file for details.
53+
54+
---
55+
56+
## 🙌 Acknowledgements
57+
58+
- Based on the original design by [OpenGammaProject](https://github.com/OpenGammaProject/Open-Gamma-Detector)
59+
- Thanks to the open hardware and spectroscopy communities!
60+
61+
---

0 commit comments

Comments
 (0)