diff --git a/.gitea/workflows/build_relase.yaml b/.gitea/workflows/build_relase.yaml index bf55f88..2f009f2 100644 --- a/.gitea/workflows/build_relase.yaml +++ b/.gitea/workflows/build_relase.yaml @@ -1,67 +1,47 @@ -name: Build and Release mxPIC Wheels +name: Build Linux and Release mxPIC -# This tells GitHub to ONLY run this pipeline when you push a version tag (e.g., v1.0.0) on: release: - types: [published] + [published] jobs: - # --- JOB 1: THE COMPILER --- - build-wheels: - name: Build on ${{ matrix.os }} - # The matrix allows us to build for Windows and Linux simultaneously! - runs-on: ${{ matrix.os }} - strategy: - matrix: - os: [ubuntu-latest, windows-latest] - python-version: ['3.10'] - + build-and-release: + name: Build Linux & Publish Release + # This targets your Docker runner on the Synology NAS + runs-on: ubuntu-latest + steps: - name: Checkout Code uses: actions/checkout@v4 - - name: Set up Python ${{ matrix.python-version }} + - name: Set up Python 3.10 uses: actions/setup-python@v5 with: - python-version: ${{ matrix.python-version }} + python-version: '3.10' - name: Install Build Dependencies - # Install the tools required by our custom build_wheel.py script run: | python -m pip install --upgrade pip pip install build wheel mypy Cython setuptools - - name: Run Auto-Builder (Compiles C-extensions & Injects .pyi) + - name: Run Auto-Builder (Compiles Linux C-extensions & Injects .pyi) + # This generates the linux_x86_64.whl inside the dist/ folder run: python build_wheel.py - - name: Temporarily Store the Built Wheel - uses: actions/upload-artifact@v4 - with: - name: mxpic-wheels-${{ matrix.os }} - path: dist/*.whl - retention-days: 1 + - name: Inject Prebuilt Windows Wheel + # This copies your locally-built Windows wheel into the dist/ folder + # so they sit side-by-side right before the release is published. + run: | + if [ -d "prebuilt_wheels" ]; then + cp prebuilt_wheels/*.whl dist/ || true + echo "✅ Windows wheel staged for release." + else + echo "⚠️ No prebuilt_wheels directory found." + fi - # --- JOB 2: THE RELEASER --- - create-release: - name: Publish to GitHub Releases - needs: build-wheels # Waits for both Windows and Linux to finish - runs-on: ubuntu-latest - permissions: - contents: write # Required to allow the bot to create a release page - - steps: - - name: Checkout Code - uses: actions/checkout@v4 - - - name: Download all OS Wheels - uses: actions/download-artifact@v4 - with: - pattern: mxpic-wheels-* - path: dist - merge-multiple: true - - - name: Upload Assets to Gitea Release - uses: softprops/action-gh-release@v1 + - name: Create Gitea Release + uses: https://gitea.com/actions/release-action@main with: + # This command scopes up everything currently sitting in the dist/ folder files: "dist/*.whl" api_key: ${{ secrets.GITEA_TOKEN }} \ No newline at end of file diff --git a/_test_.py b/_test_.py index 1915d51..476ddc2 100644 --- a/_test_.py +++ b/_test_.py @@ -1,8 +1,15 @@ # import mxpic as mx -import mxpic_release.mxpic as mx +import mxpic as mx +import nazca as nd +import matplotlib +matplotlib.use('Agg') +import matplotlib.pyplot as plt # <-- Add this import -EC = mx.EC_dual_layer_px3(name="xxx",w_in=0.5,L_in=10,Ltp1=10,Ltp2=10,Ltp3=10) +EC = mx.EC_dual_layer_px3(name="xxx",w_in=0.5,L_in=10,Ltp1=100,Ltp2=200,Ltp3=300) +nd.export_plt(topcells=EC.cell,path="",title="test",filename="file.plt") +plt.savefig("test", bbox_inches='tight', dpi=300) +plt.close() # import uuid # mac = uuid.getnode() # mc_addr = ':'.join(("%012X" % mac)[i:i+2] for i in range(0, 12, 2)) diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle new file mode 100644 index 0000000..50931f7 Binary files /dev/null and b/docs/build/doctrees/environment.pickle differ diff --git a/mxpic/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree similarity index 94% rename from mxpic/docs/build/doctrees/index.doctree rename to docs/build/doctrees/index.doctree index 4a5a81d..f4bd8af 100644 Binary files a/mxpic/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/mxpic/components/primitives/EC_dual_layer_px3.doctree b/docs/build/doctrees/mxpic/components/primitives/EC_dual_layer_px3.doctree new file mode 100644 index 0000000..d76641b Binary files /dev/null and b/docs/build/doctrees/mxpic/components/primitives/EC_dual_layer_px3.doctree differ diff --git a/docs/build/doctrees/mxpic/components/primitives/beam_splitters.doctree b/docs/build/doctrees/mxpic/components/primitives/beam_splitters.doctree new file mode 100644 index 0000000..390a022 Binary files /dev/null and b/docs/build/doctrees/mxpic/components/primitives/beam_splitters.doctree differ diff --git a/docs/build/doctrees/mxpic/components/primitives/directional_couplers.doctree b/docs/build/doctrees/mxpic/components/primitives/directional_couplers.doctree new file mode 100644 index 0000000..fd4b0b0 Binary files /dev/null and b/docs/build/doctrees/mxpic/components/primitives/directional_couplers.doctree differ diff --git a/docs/build/doctrees/mxpic/components/primitives/grating_couplers.doctree b/docs/build/doctrees/mxpic/components/primitives/grating_couplers.doctree new file mode 100644 index 0000000..ded6a68 Binary files /dev/null and b/docs/build/doctrees/mxpic/components/primitives/grating_couplers.doctree differ diff --git a/docs/build/doctrees/mxpic/components/primitives/multimode_interferometers.doctree b/docs/build/doctrees/mxpic/components/primitives/multimode_interferometers.doctree new file mode 100644 index 0000000..e3069e8 Binary files /dev/null and b/docs/build/doctrees/mxpic/components/primitives/multimode_interferometers.doctree differ diff --git a/docs/build/doctrees/mxpic/components/primitives/spiral.doctree b/docs/build/doctrees/mxpic/components/primitives/spiral.doctree new file mode 100644 index 0000000..1711c9f Binary files /dev/null and b/docs/build/doctrees/mxpic/components/primitives/spiral.doctree differ diff --git a/mxpic/docs/build/html/.buildinfo b/docs/build/html/.buildinfo similarity index 100% rename from mxpic/docs/build/html/.buildinfo rename to docs/build/html/.buildinfo diff --git a/docs/build/html/_images/BS_tdc.png b/docs/build/html/_images/BS_tdc.png new file mode 100644 index 0000000..cca00f3 Binary files /dev/null and b/docs/build/html/_images/BS_tdc.png differ diff --git a/docs/build/html/_images/DC.png b/docs/build/html/_images/DC.png new file mode 100644 index 0000000..3fc001a Binary files /dev/null and b/docs/build/html/_images/DC.png differ diff --git a/docs/build/html/_images/DC_bend.png b/docs/build/html/_images/DC_bend.png new file mode 100644 index 0000000..f68d998 Binary files /dev/null and b/docs/build/html/_images/DC_bend.png differ diff --git a/docs/build/html/_images/DC_pX_3sg.png b/docs/build/html/_images/DC_pX_3sg.png new file mode 100644 index 0000000..a21782c Binary files /dev/null and b/docs/build/html/_images/DC_pX_3sg.png differ diff --git a/docs/build/html/_images/EC_dual_layer_px3.png b/docs/build/html/_images/EC_dual_layer_px3.png new file mode 100644 index 0000000..489d4fd Binary files /dev/null and b/docs/build/html/_images/EC_dual_layer_px3.png differ diff --git a/docs/build/html/_images/GC_STD_1D.png b/docs/build/html/_images/GC_STD_1D.png new file mode 100644 index 0000000..ccd07ce Binary files /dev/null and b/docs/build/html/_images/GC_STD_1D.png differ diff --git a/docs/build/html/_images/GC_STD_2D.png b/docs/build/html/_images/GC_STD_2D.png new file mode 100644 index 0000000..ba0bf2c Binary files /dev/null and b/docs/build/html/_images/GC_STD_2D.png differ diff --git a/docs/build/html/_images/Grating_2D_Hole.png b/docs/build/html/_images/Grating_2D_Hole.png new file mode 100644 index 0000000..2320eb6 Binary files /dev/null and b/docs/build/html/_images/Grating_2D_Hole.png differ diff --git a/docs/build/html/_images/MDM.png b/docs/build/html/_images/MDM.png new file mode 100644 index 0000000..f571c40 Binary files /dev/null and b/docs/build/html/_images/MDM.png differ diff --git a/docs/build/html/_images/MMI_ML.png b/docs/build/html/_images/MMI_ML.png new file mode 100644 index 0000000..c886a18 Binary files /dev/null and b/docs/build/html/_images/MMI_ML.png differ diff --git a/docs/build/html/_images/MMI_STD.png b/docs/build/html/_images/MMI_STD.png new file mode 100644 index 0000000..91c18cc Binary files /dev/null and b/docs/build/html/_images/MMI_STD.png differ diff --git a/docs/build/html/_images/Nano_ant.png b/docs/build/html/_images/Nano_ant.png new file mode 100644 index 0000000..6e21c0d Binary files /dev/null and b/docs/build/html/_images/Nano_ant.png differ diff --git a/docs/build/html/_images/Spiral_Cicle_MM.png b/docs/build/html/_images/Spiral_Cicle_MM.png new file mode 100644 index 0000000..e498b86 Binary files /dev/null and b/docs/build/html/_images/Spiral_Cicle_MM.png differ diff --git a/docs/build/html/_images/Spiral_Cicle_STD.png b/docs/build/html/_images/Spiral_Cicle_STD.png new file mode 100644 index 0000000..d1d2b88 Binary files /dev/null and b/docs/build/html/_images/Spiral_Cicle_STD.png differ diff --git a/docs/build/html/_images/Taper.png b/docs/build/html/_images/Taper.png new file mode 100644 index 0000000..f8b619c Binary files /dev/null and b/docs/build/html/_images/Taper.png differ diff --git a/docs/build/html/_images/YBranch.png b/docs/build/html/_images/YBranch.png new file mode 100644 index 0000000..ee4394e Binary files /dev/null and b/docs/build/html/_images/YBranch.png differ diff --git a/docs/build/html/_images/Ybranch_3wg.png b/docs/build/html/_images/Ybranch_3wg.png new file mode 100644 index 0000000..cde08d3 Binary files /dev/null and b/docs/build/html/_images/Ybranch_3wg.png differ diff --git a/docs/build/html/_images/ring_bus_wg.png b/docs/build/html/_images/ring_bus_wg.png new file mode 100644 index 0000000..1600145 Binary files /dev/null and b/docs/build/html/_images/ring_bus_wg.png differ diff --git a/docs/build/html/_images/spiral.png b/docs/build/html/_images/spiral.png new file mode 100644 index 0000000..d72b82b Binary files /dev/null and b/docs/build/html/_images/spiral.png differ diff --git a/docs/build/html/_images/spiral_circle.png b/docs/build/html/_images/spiral_circle.png new file mode 100644 index 0000000..3b36483 Binary files /dev/null and b/docs/build/html/_images/spiral_circle.png differ diff --git a/mxpic/docs/build/html/_sources/index.md.txt b/docs/build/html/_sources/index.md.txt similarity index 100% rename from mxpic/docs/build/html/_sources/index.md.txt rename to docs/build/html/_sources/index.md.txt diff --git a/docs/build/html/_sources/mxpic/components/primitives/EC_dual_layer_px3.md.txt b/docs/build/html/_sources/mxpic/components/primitives/EC_dual_layer_px3.md.txt new file mode 100644 index 0000000..e10ec8d --- /dev/null +++ b/docs/build/html/_sources/mxpic/components/primitives/EC_dual_layer_px3.md.txt @@ -0,0 +1,20 @@ +# mxpic.components.primitives.EC_dual_layer_px3 + +```{eval-rst} +.. automodule:: mxpic.components.primitives.EC_dual_layer_px3 + :no-members: +``` + +## EC_dual_layer_px3 + +```{eval-rst} +.. image:: EC_dual_layer_px3.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.EC_dual_layer_px3.EC_dual_layer_px3 + :members: + :undoc-members: + :show-inheritance: +``` + diff --git a/docs/build/html/_sources/mxpic/components/primitives/beam_splitters.md.txt b/docs/build/html/_sources/mxpic/components/primitives/beam_splitters.md.txt new file mode 100644 index 0000000..51361de --- /dev/null +++ b/docs/build/html/_sources/mxpic/components/primitives/beam_splitters.md.txt @@ -0,0 +1,33 @@ +# mxpic.components.primitives.beam_splitters + +```{eval-rst} +.. automodule:: mxpic.components.primitives.beam_splitters + :no-members: +``` + +## YBranch + +```{eval-rst} +.. image:: YBranch.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.beam_splitters.YBranch + :members: + :undoc-members: + :show-inheritance: +``` + +## Ybranch_3wg + +```{eval-rst} +.. image:: Ybranch_3wg.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.beam_splitters.Ybranch_3wg + :members: + :undoc-members: + :show-inheritance: +``` + diff --git a/docs/build/html/_sources/mxpic/components/primitives/directional_couplers.md.txt b/docs/build/html/_sources/mxpic/components/primitives/directional_couplers.md.txt new file mode 100644 index 0000000..168b974 --- /dev/null +++ b/docs/build/html/_sources/mxpic/components/primitives/directional_couplers.md.txt @@ -0,0 +1,98 @@ +# mxpic.components.primitives.directional_couplers + +```{eval-rst} +.. automodule:: mxpic.components.primitives.directional_couplers + :no-members: +``` + +## ADC_STD_2x2 + +```{eval-rst} +.. image:: ADC_STD_2x2.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.directional_couplers.ADC_STD_2x2 + :members: + :undoc-members: + :show-inheritance: +``` + +## BS_tdc + +```{eval-rst} +.. image:: BS_tdc.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.directional_couplers.BS_tdc + :members: + :undoc-members: + :show-inheritance: +``` + +## DC + +```{eval-rst} +.. image:: DC.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.directional_couplers.DC + :members: + :undoc-members: + :show-inheritance: +``` + +## DC_bend + +```{eval-rst} +.. image:: DC_bend.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.directional_couplers.DC_bend + :members: + :undoc-members: + :show-inheritance: +``` + +## DC_pX_3sg + +```{eval-rst} +.. image:: DC_pX_3sg.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.directional_couplers.DC_pX_3sg + :members: + :undoc-members: + :show-inheritance: +``` + +## MDM + +```{eval-rst} +.. image:: MDM.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.directional_couplers.MDM + :members: + :undoc-members: + :show-inheritance: +``` + +## ring_bus_wg + +```{eval-rst} +.. image:: ring_bus_wg.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.directional_couplers.ring_bus_wg + :members: + :undoc-members: + :show-inheritance: +``` + diff --git a/docs/build/html/_sources/mxpic/components/primitives/grating_couplers.md.txt b/docs/build/html/_sources/mxpic/components/primitives/grating_couplers.md.txt new file mode 100644 index 0000000..9d36fb0 --- /dev/null +++ b/docs/build/html/_sources/mxpic/components/primitives/grating_couplers.md.txt @@ -0,0 +1,111 @@ +# mxpic.components.primitives.grating_couplers + +```{eval-rst} +.. automodule:: mxpic.components.primitives.grating_couplers + :no-members: +``` + +## FA + +```{eval-rst} +.. image:: FA.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.grating_couplers.FA + :members: + :undoc-members: + :show-inheritance: +``` + +## GC_STD_1D + +```{eval-rst} +.. image:: GC_STD_1D.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.grating_couplers.GC_STD_1D + :members: + :undoc-members: + :show-inheritance: +``` + +## GC_STD_2D + +```{eval-rst} +.. image:: GC_STD_2D.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.grating_couplers.GC_STD_2D + :members: + :undoc-members: + :show-inheritance: +``` + +## Grating_2D_Hole + +```{eval-rst} +.. image:: Grating_2D_Hole.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.grating_couplers.Grating_2D_Hole + :members: + :undoc-members: + :show-inheritance: +``` + +## Grating_2D_Hole_3Rec + +```{eval-rst} +.. image:: Grating_2D_Hole_3Rec.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.grating_couplers.Grating_2D_Hole_3Rec + :members: + :undoc-members: + :show-inheritance: +``` + +## Grating_2D_Hole_4Rec + +```{eval-rst} +.. image:: Grating_2D_Hole_4Rec.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.grating_couplers.Grating_2D_Hole_4Rec + :members: + :undoc-members: + :show-inheritance: +``` + +## Nano_ant + +```{eval-rst} +.. image:: Nano_ant.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.grating_couplers.Nano_ant + :members: + :undoc-members: + :show-inheritance: +``` + +## Taper + +```{eval-rst} +.. image:: Taper.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.grating_couplers.Taper + :members: + :undoc-members: + :show-inheritance: +``` + diff --git a/docs/build/html/_sources/mxpic/components/primitives/multimode_interferometers.md.txt b/docs/build/html/_sources/mxpic/components/primitives/multimode_interferometers.md.txt new file mode 100644 index 0000000..5d3d385 --- /dev/null +++ b/docs/build/html/_sources/mxpic/components/primitives/multimode_interferometers.md.txt @@ -0,0 +1,33 @@ +# mxpic.components.primitives.multimode_interferometers + +```{eval-rst} +.. automodule:: mxpic.components.primitives.multimode_interferometers + :no-members: +``` + +## MMI_ML + +```{eval-rst} +.. image:: MMI_ML.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.multimode_interferometers.MMI_ML + :members: + :undoc-members: + :show-inheritance: +``` + +## MMI_STD + +```{eval-rst} +.. image:: MMI_STD.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.multimode_interferometers.MMI_STD + :members: + :undoc-members: + :show-inheritance: +``` + diff --git a/docs/build/html/_sources/mxpic/components/primitives/spiral.md.txt b/docs/build/html/_sources/mxpic/components/primitives/spiral.md.txt new file mode 100644 index 0000000..07096c1 --- /dev/null +++ b/docs/build/html/_sources/mxpic/components/primitives/spiral.md.txt @@ -0,0 +1,85 @@ +# mxpic.components.primitives.spiral + +```{eval-rst} +.. automodule:: mxpic.components.primitives.spiral + :no-members: +``` + +## Spiral_Cicle_MM + +```{eval-rst} +.. image:: Spiral_Cicle_MM.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.spiral.Spiral_Cicle_MM + :members: + :undoc-members: + :show-inheritance: +``` + +## Spiral_Cicle_STD + +```{eval-rst} +.. image:: Spiral_Cicle_STD.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.spiral.Spiral_Cicle_STD + :members: + :undoc-members: + :show-inheritance: +``` + +## Spiral_Rect_STD + +```{eval-rst} +.. image:: Spiral_Rect_STD.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.spiral.Spiral_Rect_STD + :members: + :undoc-members: + :show-inheritance: +``` + +## spiral + +```{eval-rst} +.. image:: spiral.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.spiral.spiral + :members: + :undoc-members: + :show-inheritance: +``` + +## spiral_circle + +```{eval-rst} +.. image:: spiral_circle.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.spiral.spiral_circle + :members: + :undoc-members: + :show-inheritance: +``` + +## spiral_rectangle + +```{eval-rst} +.. image:: spiral_rectangle.png + :align: center + :width: 600px + +.. autoclass:: mxpic.components.primitives.spiral.spiral_rectangle + :members: + :undoc-members: + :show-inheritance: +``` + diff --git a/mxpic/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css similarity index 100% rename from mxpic/docs/build/html/_static/basic.css rename to docs/build/html/_static/basic.css diff --git a/mxpic/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js similarity index 100% rename from mxpic/docs/build/html/_static/doctools.js rename to docs/build/html/_static/doctools.js diff --git a/mxpic/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js similarity index 100% rename from mxpic/docs/build/html/_static/documentation_options.js rename to docs/build/html/_static/documentation_options.js diff --git a/mxpic/docs/build/html/_static/file.png b/docs/build/html/_static/file.png similarity index 100% rename from mxpic/docs/build/html/_static/file.png rename to docs/build/html/_static/file.png diff --git a/mxpic/docs/build/html/_static/language_data.js b/docs/build/html/_static/language_data.js similarity index 100% rename from mxpic/docs/build/html/_static/language_data.js rename to docs/build/html/_static/language_data.js diff --git a/mxpic/docs/build/html/_static/minus.png b/docs/build/html/_static/minus.png similarity index 100% rename from mxpic/docs/build/html/_static/minus.png rename to docs/build/html/_static/minus.png diff --git a/mxpic/docs/build/html/_static/plus.png b/docs/build/html/_static/plus.png similarity index 100% rename from mxpic/docs/build/html/_static/plus.png rename to docs/build/html/_static/plus.png diff --git a/mxpic/docs/build/html/_static/pygments.css b/docs/build/html/_static/pygments.css similarity index 100% rename from mxpic/docs/build/html/_static/pygments.css rename to docs/build/html/_static/pygments.css diff --git a/mxpic/docs/build/html/_static/scripts/bootstrap.js b/docs/build/html/_static/scripts/bootstrap.js similarity index 100% rename from mxpic/docs/build/html/_static/scripts/bootstrap.js rename to docs/build/html/_static/scripts/bootstrap.js diff --git a/mxpic/docs/build/html/_static/scripts/bootstrap.js.LICENSE.txt b/docs/build/html/_static/scripts/bootstrap.js.LICENSE.txt similarity index 100% rename from mxpic/docs/build/html/_static/scripts/bootstrap.js.LICENSE.txt rename to docs/build/html/_static/scripts/bootstrap.js.LICENSE.txt diff --git a/mxpic/docs/build/html/_static/scripts/bootstrap.js.map b/docs/build/html/_static/scripts/bootstrap.js.map similarity index 100% rename from mxpic/docs/build/html/_static/scripts/bootstrap.js.map rename to docs/build/html/_static/scripts/bootstrap.js.map diff --git a/mxpic/docs/build/html/_static/scripts/fontawesome.js b/docs/build/html/_static/scripts/fontawesome.js similarity index 100% rename from mxpic/docs/build/html/_static/scripts/fontawesome.js rename to docs/build/html/_static/scripts/fontawesome.js diff --git a/mxpic/docs/build/html/_static/scripts/fontawesome.js.LICENSE.txt b/docs/build/html/_static/scripts/fontawesome.js.LICENSE.txt similarity index 100% rename from mxpic/docs/build/html/_static/scripts/fontawesome.js.LICENSE.txt rename to docs/build/html/_static/scripts/fontawesome.js.LICENSE.txt diff --git a/mxpic/docs/build/html/_static/scripts/fontawesome.js.map b/docs/build/html/_static/scripts/fontawesome.js.map similarity index 100% rename from mxpic/docs/build/html/_static/scripts/fontawesome.js.map rename to docs/build/html/_static/scripts/fontawesome.js.map diff --git a/mxpic/docs/build/html/_static/scripts/pydata-sphinx-theme.js b/docs/build/html/_static/scripts/pydata-sphinx-theme.js similarity index 100% rename from mxpic/docs/build/html/_static/scripts/pydata-sphinx-theme.js rename to docs/build/html/_static/scripts/pydata-sphinx-theme.js diff --git a/mxpic/docs/build/html/_static/scripts/pydata-sphinx-theme.js.map b/docs/build/html/_static/scripts/pydata-sphinx-theme.js.map similarity index 100% rename from mxpic/docs/build/html/_static/scripts/pydata-sphinx-theme.js.map rename to docs/build/html/_static/scripts/pydata-sphinx-theme.js.map diff --git a/mxpic/docs/build/html/_static/searchtools.js b/docs/build/html/_static/searchtools.js similarity index 100% rename from mxpic/docs/build/html/_static/searchtools.js rename to docs/build/html/_static/searchtools.js diff --git a/mxpic/docs/build/html/_static/sphinx_highlight.js b/docs/build/html/_static/sphinx_highlight.js similarity index 100% rename from mxpic/docs/build/html/_static/sphinx_highlight.js rename to docs/build/html/_static/sphinx_highlight.js diff --git a/mxpic/docs/build/html/_static/styles/pydata-sphinx-theme.css b/docs/build/html/_static/styles/pydata-sphinx-theme.css similarity index 100% rename from mxpic/docs/build/html/_static/styles/pydata-sphinx-theme.css rename to docs/build/html/_static/styles/pydata-sphinx-theme.css diff --git a/mxpic/docs/build/html/_static/styles/pydata-sphinx-theme.css.map b/docs/build/html/_static/styles/pydata-sphinx-theme.css.map similarity index 100% rename from mxpic/docs/build/html/_static/styles/pydata-sphinx-theme.css.map rename to docs/build/html/_static/styles/pydata-sphinx-theme.css.map diff --git a/mxpic/docs/build/html/_static/styles/theme.css b/docs/build/html/_static/styles/theme.css similarity index 100% rename from mxpic/docs/build/html/_static/styles/theme.css rename to docs/build/html/_static/styles/theme.css diff --git a/mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-brands-400.ttf b/docs/build/html/_static/vendor/fontawesome/webfonts/fa-brands-400.ttf similarity index 100% rename from mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-brands-400.ttf rename to docs/build/html/_static/vendor/fontawesome/webfonts/fa-brands-400.ttf diff --git a/mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-brands-400.woff2 b/docs/build/html/_static/vendor/fontawesome/webfonts/fa-brands-400.woff2 similarity index 100% rename from mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-brands-400.woff2 rename to docs/build/html/_static/vendor/fontawesome/webfonts/fa-brands-400.woff2 diff --git a/mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-regular-400.ttf b/docs/build/html/_static/vendor/fontawesome/webfonts/fa-regular-400.ttf similarity index 100% rename from mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-regular-400.ttf rename to docs/build/html/_static/vendor/fontawesome/webfonts/fa-regular-400.ttf diff --git a/mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-regular-400.woff2 b/docs/build/html/_static/vendor/fontawesome/webfonts/fa-regular-400.woff2 similarity index 100% rename from mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-regular-400.woff2 rename to docs/build/html/_static/vendor/fontawesome/webfonts/fa-regular-400.woff2 diff --git a/mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-solid-900.ttf b/docs/build/html/_static/vendor/fontawesome/webfonts/fa-solid-900.ttf similarity index 100% rename from mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-solid-900.ttf rename to docs/build/html/_static/vendor/fontawesome/webfonts/fa-solid-900.ttf diff --git a/mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-solid-900.woff2 b/docs/build/html/_static/vendor/fontawesome/webfonts/fa-solid-900.woff2 similarity index 100% rename from mxpic/docs/build/html/_static/vendor/fontawesome/webfonts/fa-solid-900.woff2 rename to docs/build/html/_static/vendor/fontawesome/webfonts/fa-solid-900.woff2 diff --git a/mxpic/docs/build/html/_static/webpack-macros.html b/docs/build/html/_static/webpack-macros.html similarity index 100% rename from mxpic/docs/build/html/_static/webpack-macros.html rename to docs/build/html/_static/webpack-macros.html diff --git a/mxpic/docs/build/html/genindex.html b/docs/build/html/genindex.html similarity index 98% rename from mxpic/docs/build/html/genindex.html rename to docs/build/html/genindex.html index 27d559e..6918f99 100644 --- a/mxpic/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -123,35 +123,35 @@
  • - mxpic\components\primitives\beam_splitters + mxpic.components.primitives.beam_splitters
  • - mxpic\components\primitives\directional_couplers + mxpic.components.primitives.directional_couplers
  • - mxpic\components\primitives\EC_dual_layer_px3 + mxpic.components.primitives.EC_dual_layer_px3
  • - mxpic\components\primitives\grating_couplers + mxpic.components.primitives.grating_couplers
  • - mxpic\components\primitives\multimode_interferometers + mxpic.components.primitives.multimode_interferometers
    • @@ -165,7 +165,7 @@
  • - mxpic\components\primitives\spiral + mxpic.components.primitives.spiral
    • @@ -245,42 +245,42 @@
  • - mxpic\components\primitives\beam_splitters + mxpic.components.primitives.beam_splitters
  • - mxpic\components\primitives\directional_couplers + mxpic.components.primitives.directional_couplers
  • - mxpic\components\primitives\EC_dual_layer_px3 + mxpic.components.primitives.EC_dual_layer_px3
  • - mxpic\components\primitives\grating_couplers + mxpic.components.primitives.grating_couplers
  • - mxpic\components\primitives\multimode_interferometers + mxpic.components.primitives.multimode_interferometers
  • - mxpic\components\primitives\spiral + mxpic.components.primitives.spiral
    • diff --git a/mxpic/docs/build/html/index.html b/docs/build/html/index.html similarity index 70% rename from mxpic/docs/build/html/index.html rename to docs/build/html/index.html index 0082ad0..9ced77c 100644 --- a/mxpic/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -44,7 +44,7 @@ - + @@ -125,35 +125,35 @@
  • - mxpic\components\primitives\beam_splitters + mxpic.components.primitives.beam_splitters
  • - mxpic\components\primitives\directional_couplers + mxpic.components.primitives.directional_couplers
  • - mxpic\components\primitives\EC_dual_layer_px3 + mxpic.components.primitives.EC_dual_layer_px3
  • - mxpic\components\primitives\grating_couplers + mxpic.components.primitives.grating_couplers
  • - mxpic\components\primitives\multimode_interferometers + mxpic.components.primitives.multimode_interferometers
    • @@ -167,7 +167,7 @@
  • - mxpic\components\primitives\spiral + mxpic.components.primitives.spiral
    • @@ -251,42 +251,42 @@
  • - mxpic\components\primitives\beam_splitters + mxpic.components.primitives.beam_splitters
  • - mxpic\components\primitives\directional_couplers + mxpic.components.primitives.directional_couplers
  • - mxpic\components\primitives\EC_dual_layer_px3 + mxpic.components.primitives.EC_dual_layer_px3
  • - mxpic\components\primitives\grating_couplers + mxpic.components.primitives.grating_couplers
  • - mxpic\components\primitives\multimode_interferometers + mxpic.components.primitives.multimode_interferometers
  • - mxpic\components\primitives\spiral + mxpic.components.primitives.spiral
    • @@ -349,48 +349,48 @@ contain the root to

    Components:

    @@ -373,10 +373,14 @@
    -

    mxpic\components\primitives\EC_dual_layer_px3#

    +

    mxpic.components.primitives.EC_dual_layer_px3#

    +
    +

    EC_dual_layer_px3#

    +mxpic/components/primitives/EC_dual_layer_px3.png +
    -class mxpic.components.primitives.EC_dual_layer_px3.EC_dual_layer_px3(name, w_in, L_in, Ltp1, Ltp2, Ltp3, L_end=0, w_tip_core=0.2, w1_slab=0.6, w_tip_slab=0.2, w_mid_slab=0.45, w_box=8, w_box_end=12, L_box_end=2, w_DT=12, xs_SiN='sin', layer_SiN_slab='SiN_Rib_WG', layer_DT='OXIDE_FACET', xs_Trench='air_trench', layer_top_cover='PAD_OPTICAL', layer_dum_exl_be=None, angle_tile=8, R_bend=50)#
    +class mxpic.components.primitives.EC_dual_layer_px3.EC_dual_layer_px3(name=None, w_in=1.0, L_in=15, Ltp1=100, Ltp2=200, Ltp3=400, L_end=0, w_tip_core=0.2, w1_slab=0.6, w_tip_slab=0.2, w_mid_slab=0.45, w_box=8, w_box_end=12, L_box_end=2, w_DT=12, xs_SiN='sin', layer_SiN_slab='SiN_Rib_WG', layer_DT='OXIDE_FACET', xs_Trench='air_trench', layer_top_cover='PAD_OPTICAL', layer_dum_exl_be=None, angle_tile=8, R_bend=50, sample_build=False)#

    Bases: object

    Dual-layer Edge Coupler (Spot Size Converter) for fiber-to-chip coupling.

    This component manages the adiabatic transition between a high-index @@ -418,6 +422,7 @@ contrast core and a secondary slab/cladding layer (e.g., SiN to SOI).

    +
    @@ -436,7 +441,7 @@ contrast core and a secondary slab/cladding layer (e.g., SiN to SOI).

    previous

    -

    mxpic\components\primitives\directional_couplers

    +

    mxpic.components.primitives.directional_couplers

    title="next page">

    next

    -

    mxpic\components\primitives\grating_couplers

    +

    mxpic.components.primitives.grating_couplers

     @@ -467,8 +472,11 @@ contrast core and a secondary slab/cladding layer (e.g., SiN to SOI).

    @@ -373,7 +373,11 @@
    -

    mxpic\components\primitives\beam_splitters#

    +

    mxpic.components.primitives.beam_splitters#

    +
    +

    YBranch#

    +../../../_images/YBranch.png +
    class mxpic.components.primitives.beam_splitters.YBranch(name=None, xs='strip', w=[1.2, 1.0, 1.8, 1.2, 1.0, 1.2, 1.2], L=6, R_att=10, A_att=10, w_port=0.45, show_pins=False, sharp_patch=True, res=0.1)#
    @@ -403,6 +407,11 @@ Length must be >= 2. Default is
    +
    +
    +

    Ybranch_3wg#

    +../../../_images/Ybranch_3wg.png +
    class mxpic.components.primitives.beam_splitters.Ybranch_3wg(name=None, w0=0.4, w1=0.2, gap=0.18, Lcp=20, xs='strip', w_wg=0.45, R0=10, angle=20, L_attach=3, L_in_tp=3, sharp_patch=True)#
    @@ -440,6 +449,7 @@ Length must be >= 2. Default is
    +
    @@ -466,7 +476,7 @@ Length must be >= 2. Default is

    next

    -

    mxpic\components\primitives\directional_couplers

    +

    mxpic.components.primitives.directional_couplers

    @@ -489,13 +499,19 @@ Length must be >= 2. Default is @@ -373,7 +373,11 @@
    -

    mxpic\components\primitives\directional_couplers#

    +

    mxpic.components.primitives.directional_couplers#

    +
    +

    ADC_STD_2x2#

    +mxpic/components/primitives/ADC_STD_2x2.png +
    class mxpic.components.primitives.directional_couplers.ADC_STD_2x2(name=None, xs='strip', wu0=0.45, wu1=0.61, wu_in=0.45, wu_out=0.8, wd0=0.33, wd1=0.2, wd_in=0.45, wd_out=0.8, Lu=33, Ld=33, angle=20, g0=0.2, g1=0.2, sbend_type='euler', Rmax=None, Rmin=5, Ru0=0, Ru1=20, Rd0=20, Rd1=0, tp_angle=2, sharp_patch=True, show_pins=False, euler_points=64, res=0.1)#
    @@ -429,6 +433,11 @@
    +
    +
    +

    BS_tdc#

    +../../../_images/BS_tdc.png +
    class mxpic.components.primitives.directional_couplers.BS_tdc(name=None, xs='strip', wa0=0.35, wa1=0.45, wb0=0.55, wb1=0.45, w_wg=0.45, gap=0.2, Lt=20, R0=30, angle=15, sbend_type='circle')#
    @@ -454,6 +463,11 @@
    +
    +
    +

    DC#

    +../../../_images/DC.png +
    class mxpic.components.primitives.directional_couplers.DC(name=None, xs='strip', w_cp=0.45, w_wg=0.45, L_cp=30, angle=20, gap=0.2, sbend_type='circular', Rmax=None, Rmin=5, R0=10, tp_angle=2, sharp_patch=True, show_pins=False)#
    @@ -486,6 +500,11 @@
    +
    +
    +

    DC_bend#

    +../../../_images/DC_bend.png +
    class mxpic.components.primitives.directional_couplers.DC_bend(name=None, w_in=0.45, w_out=0.45, gap=0.2, r_in=40, theta_arc=30, w_wg=0.45, theta_ext=15, xs_wg='strip', sharp_patch=True, show_pins=False)#
    @@ -505,6 +524,11 @@ Written by HU GAOLEI at 2022.5.15.

    +
    +
    +

    DC_pX_3sg#

    +../../../_images/DC_pX_3sg.png +
    class mxpic.components.primitives.directional_couplers.DC_pX_3sg(name=None, xs_wg='strip', Lc1=10, Lp1=5, Lc2=10, Lt=1, w_cp=0.5, dw=0.1, gap=0.2, R0=10, A=15, w_wg=0.45, pX_type='symmetric', port_symmetric=True, sharp_patch=True)#
    @@ -543,6 +567,11 @@ Written by HU GAOLEI at 2022.5.15.

    +
    +
    +

    MDM#

    +../../../_images/MDM.png +
    class mxpic.components.primitives.directional_couplers.MDM(name=None, xs='strip', wb0=0.45, wb1=0.61, wb_in=0.45, wb_out=0.88, w_wg=0.45, w0=0.33, w1=0.2, gap0=0.2, Lt_bus=20, R0=40, angle=22.5, Lt_cp=None, gap1=None, Lb0=None, symmetric_BUS=True, single_end=True, Rmin=8)#
    @@ -580,6 +609,11 @@ Written by HU GAOLEI at 2022.5.15.

    +
    +
    +

    ring_bus_wg#

    +../../../_images/ring_bus_wg.png +
    class mxpic.components.primitives.directional_couplers.ring_bus_wg(xs='strip', R_cp=20, w_bus=0.5, bend_DC=True, w_wg=0.5, dLc=10, dAc=10, euler_transistion=False, dL_trans=10, dA_trans=30, R_max_trans=100, w_trans=0.5, euler_anti_bend=False, R_max_anti=100, R_min_anti=10, A_anti=None, res=0.1, wg_Ltp=5, dL_p2p=None, sharp_patch=True, show_pins=False, end_patch=False, clothoid_order=1)#
    @@ -621,6 +655,7 @@ Written by HU GAOLEI at 2022.5.15.

    +
    @@ -639,7 +674,7 @@ Written by HU GAOLEI at 2022.5.15.

    previous

    -

    mxpic\components\primitives\beam_splitters

    +

    mxpic.components.primitives.beam_splitters

    title="next page">

    next

    -

    mxpic\components\primitives\EC_dual_layer_px3

    +

    mxpic.components.primitives.EC_dual_layer_px3

     @@ -670,33 +705,54 @@ Written by HU GAOLEI at 2022.5.15.

    @@ -373,7 +373,11 @@
    -

    mxpic\components\primitives\grating_couplers#

    +

    mxpic.components.primitives.grating_couplers#

    +
    +

    FA#

    +mxpic/components/primitives/FA.png +
    class mxpic.components.primitives.grating_couplers.FA(fiber_coupler, pitch, number, show_pins=False)#
    @@ -391,6 +395,11 @@
    +
    +
    +

    GC_STD_1D#

    +mxpic/components/primitives/GC_STD_1D.png +
    class mxpic.components.primitives.grating_couplers.GC_STD_1D(name=None, xs_wg='strip', w_wg=0.5, etch_type='FETCH', xs_open=None, L_taper=10, L_end=2, A_taper=30, Period=0.5, eta_etch=0.5, num=20, sector_gc=True, show_pins=False, L_tail=2, P_AR=1, L_AR=2)#
    @@ -435,6 +444,11 @@
    +
    +
    +

    GC_STD_2D#

    +mxpic/components/primitives/GC_STD_2D.png +
    class mxpic.components.primitives.grating_couplers.GC_STD_2D(name=None, etch_type='FETCH', xs_wg='grating', Dx_hole=0.3, Dy_hole=0.3, hole_shape='circle', shape='circle', xs_open=None, Px=0.57, Py=0.57, num_x=25, num_y=25, Lx_taper=50, Ly_taper=0, Lx_end=1, Ly_end=1, Lx_side=0.5, Ly_side=0.5, Lx_port=5, Ly_port=5, w_wg=0.5, show_pins=False, P_AR=0.6, L_AR=1)#
    @@ -514,6 +528,11 @@
    +
    +
    +

    Grating_2D_Hole#

    +../../../_images/Grating_2D_Hole.png +
    class mxpic.components.primitives.grating_couplers.Grating_2D_Hole(w_wg=0.5, w_gt=5, l_taper=30, type_taper='parabolic', gt_vector=[0.5, 0.5, 0.5, 0.5, 0.5], gt_diameter=0.4, gt_layer='STRIP_COR', polysi_vector=[0.5, 0.5, 0.5, 0.5, 0.5], polysi_diameter=0.4, polysi_layer='FCW_TRE', reflector_vector=[0.3, 0.3, 0.3, 0.3, 0.3, 0.3], l_field_center=1)#
    @@ -545,6 +564,11 @@ This is a class for 2D Grating in IMEC.

    +
    +
    +

    Grating_2D_Hole_3Rec#

    +mxpic/components/primitives/Grating_2D_Hole_3Rec.png +
    class mxpic.components.primitives.grating_couplers.Grating_2D_Hole_3Rec(grating_unit, mode_radius=6.5, cell_name=None, show_pins=False)#
    @@ -567,6 +591,11 @@ This is a class for 2D Grating in IMEC.

    +
    +
    +

    Grating_2D_Hole_4Rec#

    +mxpic/components/primitives/Grating_2D_Hole_4Rec.png +
    class mxpic.components.primitives.grating_couplers.Grating_2D_Hole_4Rec(grating_unit, mode_radius=8, cell_name=None, show_pins=False)#
    @@ -589,6 +618,11 @@ This is a class for 2D Grating in IMEC.

    +
    +
    +

    Nano_ant#

    +../../../_images/Nano_ant.png +
    class mxpic.components.primitives.grating_couplers.Nano_ant(w_wg=0.41, xs_wg='strip', define_type='non-periodic', vector=[0.5, 0.5, 0.5, 0.5, 0.5, 0.5], taper_length=3, width=6, max_theta=110, pitch=0.6, duty_cycle=0.3, teeth_number=6, etch_depth=['METCH'], show_pins=True)#
    @@ -635,6 +669,11 @@ This is a class for 2D Grating in IMEC.

    +
    +
    +

    Taper#

    +../../../_images/Taper.png +
    class mxpic.components.primitives.grating_couplers.Taper(width1=4, width2=0.45, length=30, type='linear', show_pins=False)#
    @@ -658,6 +697,7 @@ This is a class for 2D Grating in IMEC.

    +
    @@ -676,7 +716,7 @@ This is a class for 2D Grating in IMEC.

    previous

    -

    mxpic\components\primitives\EC_dual_layer_px3

    +

    mxpic.components.primitives.EC_dual_layer_px3

    title="next page">

    next

    -

    mxpic\components\primitives\multimode_interferometers

    +

    mxpic.components.primitives.multimode_interferometers

     @@ -707,39 +747,63 @@ This is a class for 2D Grating in IMEC.

    @@ -373,7 +373,11 @@
    -

    mxpic\components\primitives\multimode_interferometers#

    +

    mxpic.components.primitives.multimode_interferometers#

    +
    +

    MMI_ML#

    +../../../_images/MMI_ML.png +
    class mxpic.components.primitives.multimode_interferometers.MMI_ML(name=None, L_arm=[10], w_arm=[0.45, 1.35], xs='strip', arm_sine_width=False, L_mmi=[10], w_mmi=[5, 5], mmi_sine_width=False, sharp_patch=True, show_pins=False, res=0.01, N_out=3, N_in=1, Dp_out=1.5, Dp_in=1.5)#
    @@ -412,6 +416,11 @@
    +
    +
    +

    MMI_STD#

    +../../../_images/MMI_STD.png +
    class mxpic.components.primitives.multimode_interferometers.MMI_STD(name=None, N_out=3, N_in=1, L_arm=10, w_wg=0.45, w_port=1.2, xs='strip', L_mmi=10, w_mmi=5, sharp_patch=True, show_pins=False, Dp_out=1.5, Dp_in=1.5)#
    @@ -438,6 +447,7 @@
    +
    @@ -456,7 +466,7 @@

    previous

    -

    mxpic\components\primitives\grating_couplers

    +

    mxpic.components.primitives.grating_couplers

    next

    -

    mxpic\components\primitives\spiral

    +

    mxpic.components.primitives.spiral

     @@ -487,12 +497,18 @@ diff --git a/mxpic/docs/build/html/mxpic/components/primitives/spiral.html b/docs/build/html/mxpic/components/primitives/spiral.html similarity index 92% rename from mxpic/docs/build/html/mxpic/components/primitives/spiral.html rename to docs/build/html/mxpic/components/primitives/spiral.html index 5da1504..c318d58 100644 --- a/mxpic/docs/build/html/mxpic/components/primitives/spiral.html +++ b/docs/build/html/mxpic/components/primitives/spiral.html @@ -8,7 +8,7 @@ - mxpic\components\primitives\spiral — mxpic_handbook mxpic documentation + mxpic.components.primitives.spiral — mxpic_handbook mxpic documentation @@ -44,7 +44,7 @@ - + @@ -125,35 +125,35 @@
  • - mxpic\components\primitives\beam_splitters + mxpic.components.primitives.beam_splitters
  • - mxpic\components\primitives\directional_couplers + mxpic.components.primitives.directional_couplers
  • - mxpic\components\primitives\EC_dual_layer_px3 + mxpic.components.primitives.EC_dual_layer_px3
  • - mxpic\components\primitives\grating_couplers + mxpic.components.primitives.grating_couplers
  • - mxpic\components\primitives\multimode_interferometers + mxpic.components.primitives.multimode_interferometers
    • @@ -167,7 +167,7 @@
  • - mxpic\components\primitives\spiral + mxpic.components.primitives.spiral
    • @@ -249,42 +249,42 @@
  • - mxpic\components\primitives\beam_splitters + mxpic.components.primitives.beam_splitters
  • - mxpic\components\primitives\directional_couplers + mxpic.components.primitives.directional_couplers
  • - mxpic\components\primitives\EC_dual_layer_px3 + mxpic.components.primitives.EC_dual_layer_px3
  • - mxpic\components\primitives\grating_couplers + mxpic.components.primitives.grating_couplers
  • - mxpic\components\primitives\multimode_interferometers + mxpic.components.primitives.multimode_interferometers
  • - mxpic\components\primitives\spiral + mxpic.components.primitives.spiral
    • @@ -354,7 +354,7 @@ -
  • mxpic\components\primitives\spiral
    • +
  • mxpic.components.primitives.spiral
    • @@ -372,7 +372,11 @@
    -

    mxpic\components\primitives\spiral#

    +

    mxpic.components.primitives.spiral#

    +
    +

    Spiral_Cicle_MM#

    +../../../_images/Spiral_Cicle_MM.png +
    class mxpic.components.primitives.spiral.Spiral_Cicle_MM(name=None, Dmin=50, width=2, w_port=0.45, w_bend_center=1, gap=1, cycles=20, xs='strip', layer=None, Lport=10, res=0.5, rib2strip=True, port_angle=180, show_pins=False, sharp_patch=True, strict_condition=False)#
    @@ -401,6 +405,11 @@
    +
    +
    +

    Spiral_Cicle_STD#

    +../../../_images/Spiral_Cicle_STD.png +
    class mxpic.components.primitives.spiral.Spiral_Cicle_STD(name=None, Dmin=50, width=2, w_port=0.45, gap=1, cycles=20, xs='strip', layer=None, Lport=10, res=0.5, rib2strip=True, port_angle=180, show_pins=False, sharp_patch=True, strict_condition=False)#
    @@ -428,6 +437,11 @@
    +
    +
    +

    Spiral_Rect_STD#

    +mxpic/components/primitives/Spiral_Rect_STD.png +
    class mxpic.components.primitives.spiral.Spiral_Rect_STD(name=None, Dmin=50, R_bend=10, Lmin=50, width=2, w_port=0.45, gap=1, cycles=20, xs='strip', layer=None, Lport=10, in_out_align=True, res=0.5, cell_xs_transition=None, port_angle=180, show_pins=False, sharp_patch=True)#
    @@ -458,9 +472,14 @@
    +
    +
    +

    spiral#

    +../../../_images/spiral.png +
    -class mxpic.components.primitives.spiral.spiral(name=None, shape='circle', Dmin=50, R_bend=10, Rmin_euler=10, Lmin=50, width=2, w_port=0.45, w_bend_center=1, Rmin_bend_center=10, gap=1, cycles=20, xs='strip', layer=None, w_bend_port=None, Ltp_port=10, res=0.5, cell_transition=None, port_angle=180, Euler_bend=False, show_pins=False, sharp_patch=True)#
    +class mxpic.components.primitives.spiral.spiral(name=None, shape='circle', Dmin=50, R_bend=10, Rmin_euler=10, Lmin=50, width=2, w_port=0.45, w_bend_center=1, Rmin_bend_center=10, gap=1, cycles=20, xs='strip', layer=None, w_bend_port=None, Ltp_port=10, res=0.5, cell_transition=None, port_angle=180, Euler_bend=False, show_pins=False, sharp_patch=True, sample_build=False)#

    Bases: object

    Parametric waveguide spiral supporting circular or rectangular footprints.

    @@ -498,6 +517,11 @@
    +
    +
    +

    spiral_circle#

    +../../../_images/spiral_circle.png +
    class mxpic.components.primitives.spiral.spiral_circle(name=None, Dmin=50, width=2, w_port=0.45, w_bend_center=1, gap=1, cycles=20, xs='strip', layer=None, Lport=10, res=0.5, rib2strip=True, port_angle=180, Euler_Sbend=False, show_pins=False, sharp_patch=True, strict_condition=False, R_ratio_mamnual=None)#
    @@ -545,9 +569,14 @@
    +
    +
    +

    spiral_rectangle#

    +mxpic/components/primitives/spiral_rectangle.png +
    -class mxpic.components.primitives.spiral.spiral_rectangle(name=None, Dmin=50, Rmax_bend=10, Rmin_bend=10, wmin_bend=10, Lmin=50, width=2, w_port=0.45, gap=1, cycles=20, xs='strip', layer=None, w_bend_port=None, Lport=10, Ltp=10, res=0.5, cell_xs_transition=None, port_angle=180, show_pins=False, sharp_patch=True, in_out_align=True, Lpatch=0.05)#
    +class mxpic.components.primitives.spiral.spiral_rectangle(name=None, Dmin=50, Rmax_bend=10, Rmin_bend=10, wmin_bend=10, Lmin=50, width=2, w_port=0.45, gap=1, cycles=20, xs='strip', layer=None, w_bend_port=None, Lport=10, Ltp=10, res=0.5, cell_xs_transition=None, port_angle=180, show_pins=False, sharp_patch=True, in_out_align=True, Lpatch=0.05, sample_build=False)#

    Bases: object

    Rectangular spiral with optional cross-section transitions and alignment control.

    @@ -585,6 +614,7 @@
    +
    @@ -603,7 +633,7 @@

    previous

    -

    mxpic\components\primitives\multimode_interferometers

    +

    mxpic.components.primitives.multimode_interferometers

    @@ -625,21 +655,39 @@