You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update README: fix badges and improve GitHub display
- Update all badge URLs to use WMD-group organization
- Fix Python version badge (was pointing to PyPI)
- Fix escaped backticks for proper GitHub rendering
- Improve formatting with tables for CLI commands
- Add LaTeX equation rendering with GitHub math syntax
- Add DOI link for Alkauskas paper
- Improve overall structure and readability
- Add Contributing section with development setup
- Add Contact & Support section
- Add centered call-to-action at bottom
**Modern Python package for computing carrier capture rates and non-radiative recombination in semiconductors using multiphonon theory.**
9
9
10
-
CarrierCapture.py is a complete rewrite of [CarrierCapture.jl](https://github.com/WMD-group/CarrierCapture.jl) with an emphasis on clean code, performance, and interactive visualization.
10
+
CarrierCapture.py is a complete rewrite of [CarrierCapture.jl](https://github.com/WMD-group/CarrierCapture.jl) with emphasis on clean code, performance, and interactive visualization.
11
11
12
12
---
13
13
14
14
## ✨ Features
15
15
16
-
-**🧮 Complete Multiphonon Theory Implementation**
17
-
- 1D Schrödinger equation solver (ARPACK-based)
18
-
- Harmonic, Morse, and spline potential fitting
19
-
- Configuration coordinate diagrams
20
-
- Capture coefficient calculations
21
-
22
-
-**⚡ High-Performance Computing**
23
-
- Parallel parameter scanning with joblib
24
-
- Optimized with NumPy/SciPy (within 10-20% of Julia speed)
25
-
- Support for HDF5 and NPZ result storage
26
-
27
-
-**🎨 Rich Visualization**
28
-
- Publication-quality plots with Plotly
29
-
- Interactive Dash dashboard (web-based)
30
-
- Real-time parameter exploration
31
-
- Arrhenius plots, CC diagrams, 2D heatmaps
32
-
33
-
-**🔧 Command-Line Interface**
34
-
- Click-based CLI with intuitive subcommands
35
-
- YAML configuration files
36
-
- Progress bars and rich terminal output
37
-
- DFT preprocessing utilities
38
-
39
-
-**🔬 Scientific Validation**
40
-
- Validated against CarrierCapture.jl
41
-
- Comprehensive test suite (>90% coverage)
42
-
- Tutorial notebooks with real examples
16
+
### 🧮 Complete Multiphonon Theory Implementation
17
+
- 1D Schrödinger equation solver (ARPACK-based)
18
+
- Harmonic, Morse, and spline potential fitting
19
+
- Configuration coordinate diagrams
20
+
- Capture coefficient calculations
21
+
22
+
### ⚡ High-Performance Computing
23
+
- Parallel parameter scanning with `joblib`
24
+
- Optimized with NumPy/SciPy (within 10-20% of Julia speed)
-`δ`: energy-conserving delta function (Gaussian broadened)
167
+
168
+
### References
169
+
170
+
1.**Alkauskas et al.** (2014) - *First-principles calculations of luminescence spectrum line shapes for defects in semiconductors*, [Phys. Rev. B **90**, 075202](https://doi.org/10.1103/PhysRevB.90.075202)
171
+
2.**Huang & Rhys** (1950) - *Theory of Light Absorption and Non-Radiative Transitions in F-Centres*, Proc. R. Soc. Lond. A **204**, 406
Benchmarked against CarrierCapture.jl on typical workflows:
200
+
201
+
| Operation | Python | Julia | Ratio |
202
+
|-----------|--------|-------|-------|
203
+
| Schrödinger solver (N=5000) | 0.42 s | 0.38 s | 1.11× |
204
+
| Capture coefficient | 0.15 s | 0.13 s | 1.15× |
205
+
| Parameter scan (25×10) | 45 s | 38 s | 1.18× |
206
+
207
+
*Python within 20% of Julia due to shared ARPACK/FITPACK backends.*
208
+
209
+
---
210
+
211
+
## 🤝 Contributing
212
+
213
+
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
0 commit comments