1. Cython compile system build. 2. License system build. 3. Auto md file generation for Sphinx build.
This commit is contained in:
@@ -6,10 +6,19 @@ This is the fast-track guide to contributing to **mxPIC**. Adherence to these ru
|
||||
|
||||
### <span style="color: #ff57c7;">0. Installation dependencies</span>
|
||||
- python 3.10.1
|
||||
- nazca 0.6.1
|
||||
- numpy 1.12.0
|
||||
- pandas 0.12.0
|
||||
-
|
||||
- nazca 0.5.13
|
||||
- gdstk 1.0.0
|
||||
- numpy 1.22.3
|
||||
- pandas 1.3.3
|
||||
- matplotlib 3.4.3
|
||||
- Cython 3.2.4
|
||||
- Sphnix 7.4.7
|
||||
- myst-parser 3.0.1
|
||||
- sphinx-rtd-theme 3.1.0
|
||||
|
||||
```
|
||||
pip install sphinx myst-parser sphinx-rtd-theme gdstk==1.0.0
|
||||
```
|
||||
|
||||
## <span style="color: #ff57c7;">1. File & architecture</span>
|
||||
The repository have an archtecture like this.
|
||||
@@ -97,11 +106,11 @@ The basic routing algorthium is based the information between nodes, which is th
|
||||
|
||||
|Catagory| Prefix | name | index | expample | device instance
|
||||
|---|---|---|---|---|---|
|
||||
| Optical| opt_ | a | 1~x | opt_a1 | direction_coupler
|
||||
| Optical (Sinlge IO to waveguide)| opt_ | a | 1~x | opt_a1 |grating_coupler
|
||||
| Electrical| ele_ | a | 1~x | ele_a1 | heater/resistor
|
||||
| PN diodes| ele_ | ka/an | 1~x | ele_an1 | modulator/p-i-n waveuigde
|
||||
| Transistors (BJT)| ele_ | ba/em/cl | 1~x | ele_cl1 | BJT
|
||||
| Optical| opt_ | a | 1~x | opt_a_1 | direction_coupler
|
||||
| Optical (Sinlge IO to waveguide)| opt_ | a_ | 1~x | opt_a_1 |grating_coupler
|
||||
| Electrical| ele_ | a | 1~x | ele_a_1 | heater/resistor
|
||||
| PN diodes| ele_ | cathode/anode | 1~x | ele_anode_1 | modulator/p-i-n waveuigde
|
||||
| Transistors (BJT)| ele_ | base/em/collector | 1~x | ele_colloctor_1 | BJT
|
||||
| Transistors (MOS)| ele_ | gt/su/dr | 1~x | ele_gt1 | MOSFET
|
||||
|
||||
|
||||
@@ -113,3 +122,4 @@ nazca.add_layer_to_xsection("WG_HM",growx=2,growy=2)
|
||||
nazca.add_layer_to_xsection("WG_STRIP",growx=2,growy=2)
|
||||
```
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user