# gsim

## Getting started

- [Home](<https://gdsfactory.com/gsim/index.md>)

## Guides

- [Cloud](<https://gdsfactory.com/gsim/api/cloud/index.md>)
- [Common](<https://gdsfactory.com/gsim/api/common/index.md>)
- [GDSFactory FDTD](<https://gdsfactory.com/gsim/api/fdtd/index.md>)
- [Meep](<https://gdsfactory.com/gsim/api/meep/index.md>)
- [Palace](<https://gdsfactory.com/gsim/api/palace/index.md>)
- [TCAD](<https://gdsfactory.com/gsim/api/tcad/index.md>)
- [Transmission-line Analysis with scikit-rf](<https://gdsfactory.com/gsim/transmission_line_analysis/index.md>)
- [EMX Process Files](<https://gdsfactory.com/gsim/emx_proc_import/index.md>)
- [Palace Result Validation](<https://gdsfactory.com/gsim/palace-validation/index.md>)
- [Materials](<https://gdsfactory.com/gsim/materials/index.md>)

## Tutorials

- [Broadband Directional Coupler](<https://gdsfactory.com/gsim/nbs/fdtd_broadband_directional_coupler/index.md>)
- [Directional Coupler](<https://gdsfactory.com/gsim/nbs/fdtd_directional_coupler/index.md>)
- [3D Grating Coupler](<https://gdsfactory.com/gsim/nbs/fdtd_focusing_grating_coupler_gpdk/index.md>)
- [MMI Quickstart](<https://gdsfactory.com/gsim/nbs/fdtd_mmi_gpdk/index.md>)
- [Waveguide Crossing](<https://gdsfactory.com/gsim/nbs/fdtd_waveguide_crossing/index.md>)
- [Meep: 2D Directional Coupler](<https://gdsfactory.com/gsim/nbs/meep_2d/index.md>)
- [Meep: 2D Grating Coupler](<https://gdsfactory.com/gsim/nbs/meep_2d_xz_gc/index.md>)
- [Meep: 2D Grating Coupler Sweep](<https://gdsfactory.com/gsim/nbs/meep_2d_xz_gc_wavelength_sweep/index.md>)
- [Meep: Directional Coupler](<https://gdsfactory.com/gsim/nbs/meep_dc/index.md>)
- [Meep: 3D MMI Comparison](<https://gdsfactory.com/gsim/nbs/meep_ybranch/index.md>)
- [Branch Line Coupler](<https://gdsfactory.com/gsim/nbs/palace_branch_line_coupler/index.md>)
- [CPW Length Sweep and De-embedding](<https://gdsfactory.com/gsim/nbs/palace_cpw_deembedding/index.md>)
- [Field Visualization](<https://gdsfactory.com/gsim/nbs/palace_cpw_fields/index.md>)
- [CPW (Lumped Ports)](<https://gdsfactory.com/gsim/nbs/palace_cpw_lumped/index.md>)
- [CPW Via Transition](<https://gdsfactory.com/gsim/nbs/palace_cpw_via/index.md>)
- [CPW (Wave Ports)](<https://gdsfactory.com/gsim/nbs/palace_cpw_waveport/index.md>)
- [Inductor](<https://gdsfactory.com/gsim/nbs/palace_inductor/index.md>)
- [Inductor Port Comparison](<https://gdsfactory.com/gsim/nbs/palace_inductor_port_comparison/index.md>)
- [Microstrip](<https://gdsfactory.com/gsim/nbs/palace_microstrip/index.md>)
- [Qubit Chip (QPDK)](<https://gdsfactory.com/gsim/nbs/palace_qpdk_filled_qubit_test_chip/index.md>)
- [QPDK Resonator](<https://gdsfactory.com/gsim/nbs/palace_qpdk_resonator/index.md>)
- [Parallel Simulations: Width Sweep](<https://gdsfactory.com/gsim/nbs/palace_width_sweep/index.md>)
- [TCAD: PN Junction C(V)](<https://gdsfactory.com/gsim/nbs/tcad_pn_junction/index.md>)

## API reference

- [carriers](<https://gdsfactory.com/gsim/reference/gsim/common/carriers/index.md>)
- [cloud](<https://gdsfactory.com/gsim/reference/gsim/common/cloud/index.md>)
- [config](<https://gdsfactory.com/gsim/reference/gsim/common/config/index.md>)
- [cross\_section](<https://gdsfactory.com/gsim/reference/gsim/common/cross_section/index.md>)
- [geometry](<https://gdsfactory.com/gsim/reference/gsim/common/geometry/index.md>)
- [geometry\_model](<https://gdsfactory.com/gsim/reference/gsim/common/geometry_model/index.md>)
- [common](<https://gdsfactory.com/gsim/reference/gsim/common/index.md>)
- [junction](<https://gdsfactory.com/gsim/reference/gsim/common/junction/index.md>)
- [layered\_component](<https://gdsfactory.com/gsim/reference/gsim/common/layered_component/index.md>)
- [materials](<https://gdsfactory.com/gsim/reference/gsim/common/materials/index.md>)
- [lithium\_niobate](<https://gdsfactory.com/gsim/reference/gsim/common/materials/lithium_niobate/index.md>)
- [registry](<https://gdsfactory.com/gsim/reference/gsim/common/materials/registry/index.md>)
- [si\_li\_293k](<https://gdsfactory.com/gsim/reference/gsim/common/materials/si_li_293k/index.md>)
- [si\_salzberg](<https://gdsfactory.com/gsim/reference/gsim/common/materials/si_salzberg/index.md>)
- [sin\_luke](<https://gdsfactory.com/gsim/reference/gsim/common/materials/sin_luke/index.md>)
- [sio2\_malitson](<https://gdsfactory.com/gsim/reference/gsim/common/materials/sio2_malitson/index.md>)
- [snapshots](<https://gdsfactory.com/gsim/reference/gsim/common/materials/snapshots/index.md>)
- [mesh\_regions](<https://gdsfactory.com/gsim/reference/gsim/common/mesh_regions/index.md>)
- [modes](<https://gdsfactory.com/gsim/reference/gsim/common/modes/index.md>)
- [optional](<https://gdsfactory.com/gsim/reference/gsim/common/optional/index.md>)
- [pdk](<https://gdsfactory.com/gsim/reference/gsim/common/pdk/index.md>)
- [models](<https://gdsfactory.com/gsim/reference/gsim/common/pdk/models/index.md>)
- [resolve](<https://gdsfactory.com/gsim/reference/gsim/common/pdk/resolve/index.md>)
- [polygon](<https://gdsfactory.com/gsim/reference/gsim/common/polygon/index.md>)
- [polygon\_utils](<https://gdsfactory.com/gsim/reference/gsim/common/polygon_utils/index.md>)
- [emx](<https://gdsfactory.com/gsim/reference/gsim/common/stack/emx/index.md>)
- [extractor](<https://gdsfactory.com/gsim/reference/gsim/common/stack/extractor/index.md>)
- [stack](<https://gdsfactory.com/gsim/reference/gsim/common/stack/index.md>)
- [materials](<https://gdsfactory.com/gsim/reference/gsim/common/stack/materials/index.md>)
- [overlays](<https://gdsfactory.com/gsim/reference/gsim/common/stack/overlays/index.md>)
- [pn\_junction](<https://gdsfactory.com/gsim/reference/gsim/common/stack/pn_junction/index.md>)
- [rf\_materials](<https://gdsfactory.com/gsim/reference/gsim/common/stack/rf_materials/index.md>)
- [visualization](<https://gdsfactory.com/gsim/reference/gsim/common/stack/visualization/index.md>)
- [sweep](<https://gdsfactory.com/gsim/reference/gsim/common/sweep/index.md>)
- [types](<https://gdsfactory.com/gsim/reference/gsim/common/types/index.md>)
- [validation](<https://gdsfactory.com/gsim/reference/gsim/common/validation/index.md>)
- [viz](<https://gdsfactory.com/gsim/reference/gsim/common/viz/index.md>)
- [render2d](<https://gdsfactory.com/gsim/reference/gsim/common/viz/render2d/index.md>)
- [render2d\_interactive](<https://gdsfactory.com/gsim/reference/gsim/common/viz/render2d_interactive/index.md>)
- [render3d](<https://gdsfactory.com/gsim/reference/gsim/common/viz/render3d/index.md>)
- [render3d\_open3d](<https://gdsfactory.com/gsim/reference/gsim/common/viz/render3d_open3d/index.md>)
- [render3d\_pyvista](<https://gdsfactory.com/gsim/reference/gsim/common/viz/render3d_pyvista/index.md>)
- [api](<https://gdsfactory.com/gsim/reference/gsim/fdtd/api/index.md>)
- [config](<https://gdsfactory.com/gsim/reference/gsim/fdtd/config/index.md>)
- [domain](<https://gdsfactory.com/gsim/reference/gsim/fdtd/domain/index.md>)
- [fdtd](<https://gdsfactory.com/gsim/reference/gsim/fdtd/index.md>)
- [mesh](<https://gdsfactory.com/gsim/reference/gsim/fdtd/mesh/index.md>)
- [mesh\_geometry](<https://gdsfactory.com/gsim/reference/gsim/fdtd/mesh_geometry/index.md>)
- [mesh\_loft](<https://gdsfactory.com/gsim/reference/gsim/fdtd/mesh_loft/index.md>)
- [mesh\_validation](<https://gdsfactory.com/gsim/reference/gsim/fdtd/mesh_validation/index.md>)
- [metadata](<https://gdsfactory.com/gsim/reference/gsim/fdtd/metadata/index.md>)
- [models](<https://gdsfactory.com/gsim/reference/gsim/fdtd/models/index.md>)
- [normalization](<https://gdsfactory.com/gsim/reference/gsim/fdtd/normalization/index.md>)
- [results](<https://gdsfactory.com/gsim/reference/gsim/fdtd/results/index.md>)
- [runtime](<https://gdsfactory.com/gsim/reference/gsim/fdtd/runtime/index.md>)
- [simulation](<https://gdsfactory.com/gsim/reference/gsim/fdtd/simulation/index.md>)
- [viz](<https://gdsfactory.com/gsim/reference/gsim/fdtd/viz/index.md>)
- [workflow](<https://gdsfactory.com/gsim/reference/gsim/fdtd/workflow/index.md>)
- [gcloud](<https://gdsfactory.com/gsim/reference/gsim/gcloud/index.md>)
- [hashing](<https://gdsfactory.com/gsim/reference/gsim/hashing/index.md>)
- [gsim](<https://gdsfactory.com/gsim/reference/gsim/index.md>)
- [domain](<https://gdsfactory.com/gsim/reference/gsim/meep/domain/index.md>)
- [meep](<https://gdsfactory.com/gsim/reference/gsim/meep/index.md>)
- [index\_overlay](<https://gdsfactory.com/gsim/reference/gsim/meep/index_overlay/index.md>)
- [index\_overlay\_interactive](<https://gdsfactory.com/gsim/reference/gsim/meep/index_overlay_interactive/index.md>)
- [index\_viz](<https://gdsfactory.com/gsim/reference/gsim/meep/index_viz/index.md>)
- [index\_viz\_interactive](<https://gdsfactory.com/gsim/reference/gsim/meep/index_viz_interactive/index.md>)
- [materials](<https://gdsfactory.com/gsim/reference/gsim/meep/materials/index.md>)
- [mode\_solver](<https://gdsfactory.com/gsim/reference/gsim/meep/mode_solver/index.md>)
- [api](<https://gdsfactory.com/gsim/reference/gsim/meep/models/api/index.md>)
- [config](<https://gdsfactory.com/gsim/reference/gsim/meep/models/config/index.md>)
- [models](<https://gdsfactory.com/gsim/reference/gsim/meep/models/index.md>)
- [results](<https://gdsfactory.com/gsim/reference/gsim/meep/models/results/index.md>)
- [overlay](<https://gdsfactory.com/gsim/reference/gsim/meep/overlay/index.md>)
- [physical\_layers](<https://gdsfactory.com/gsim/reference/gsim/meep/physical_layers/index.md>)
- [pml](<https://gdsfactory.com/gsim/reference/gsim/meep/pml/index.md>)
- [ports](<https://gdsfactory.com/gsim/reference/gsim/meep/ports/index.md>)
- [results](<https://gdsfactory.com/gsim/reference/gsim/meep/results/index.md>)
- [script](<https://gdsfactory.com/gsim/reference/gsim/meep/script/index.md>)
- [simulation](<https://gdsfactory.com/gsim/reference/gsim/meep/simulation/index.md>)
- [viz](<https://gdsfactory.com/gsim/reference/gsim/meep/viz/index.md>)
- [base](<https://gdsfactory.com/gsim/reference/gsim/palace/base/index.md>)
- [boundarymode](<https://gdsfactory.com/gsim/reference/gsim/palace/boundarymode/index.md>)
- [capacitance](<https://gdsfactory.com/gsim/reference/gsim/palace/capacitance/index.md>)
- [circuit](<https://gdsfactory.com/gsim/reference/gsim/palace/circuit/index.md>)
- [driven](<https://gdsfactory.com/gsim/reference/gsim/palace/driven/index.md>)
- [eigenmode](<https://gdsfactory.com/gsim/reference/gsim/palace/eigenmode/index.md>)
- [electrostatic](<https://gdsfactory.com/gsim/reference/gsim/palace/electrostatic/index.md>)
- [field\_viz](<https://gdsfactory.com/gsim/reference/gsim/palace/field_viz/index.md>)
- [fields](<https://gdsfactory.com/gsim/reference/gsim/palace/fields/index.md>)
- [palace](<https://gdsfactory.com/gsim/reference/gsim/palace/index.md>)
- [line\_impedance](<https://gdsfactory.com/gsim/reference/gsim/palace/line_impedance/index.md>)
- [materials](<https://gdsfactory.com/gsim/reference/gsim/palace/materials/index.md>)
- [auto\_size](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/auto_size/index.md>)
- [config\_generator](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/config_generator/index.md>)
- [floquet](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/floquet/index.md>)
- [generator](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/generator/index.md>)
- [geometry](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/geometry/index.md>)
- [gmsh\_utils](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/gmsh_utils/index.md>)
- [groups](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/groups/index.md>)
- [mesh](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/index.md>)
- [metadata](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/metadata/index.md>)
- [net\_groups](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/net_groups/index.md>)
- [nets](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/nets/index.md>)
- [quality](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/quality/index.md>)
- [symmetry](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/symmetry/index.md>)
- [validation](<https://gdsfactory.com/gsim/reference/gsim/palace/mesh/validation/index.md>)
- [mode\_fields](<https://gdsfactory.com/gsim/reference/gsim/palace/mode_fields/index.md>)
- [cross\_section](<https://gdsfactory.com/gsim/reference/gsim/palace/models/cross_section/index.md>)
- [geometry](<https://gdsfactory.com/gsim/reference/gsim/palace/models/geometry/index.md>)
- [models](<https://gdsfactory.com/gsim/reference/gsim/palace/models/index.md>)
- [mesh](<https://gdsfactory.com/gsim/reference/gsim/palace/models/mesh/index.md>)
- [numerical](<https://gdsfactory.com/gsim/reference/gsim/palace/models/numerical/index.md>)
- [pec](<https://gdsfactory.com/gsim/reference/gsim/palace/models/pec/index.md>)
- [ports](<https://gdsfactory.com/gsim/reference/gsim/palace/models/ports/index.md>)
- [problems](<https://gdsfactory.com/gsim/reference/gsim/palace/models/problems/index.md>)
- [results](<https://gdsfactory.com/gsim/reference/gsim/palace/models/results/index.md>)
- [solver](<https://gdsfactory.com/gsim/reference/gsim/palace/models/solver/index.md>)
- [stack](<https://gdsfactory.com/gsim/reference/gsim/palace/models/stack/index.md>)
- [symmetry](<https://gdsfactory.com/gsim/reference/gsim/palace/models/symmetry/index.md>)
- [plane\_section](<https://gdsfactory.com/gsim/reference/gsim/palace/plane_section/index.md>)
- [config](<https://gdsfactory.com/gsim/reference/gsim/palace/ports/config/index.md>)
- [ports](<https://gdsfactory.com/gsim/reference/gsim/palace/ports/index.md>)
- [postprocessing](<https://gdsfactory.com/gsim/reference/gsim/palace/postprocessing/index.md>)
- [results](<https://gdsfactory.com/gsim/reference/gsim/palace/results/index.md>)
- [runtime](<https://gdsfactory.com/gsim/reference/gsim/palace/runtime/index.md>)
- [solver\_settings](<https://gdsfactory.com/gsim/reference/gsim/palace/solver_settings/index.md>)
- [symmetry](<https://gdsfactory.com/gsim/reference/gsim/palace/symmetry/index.md>)
- [terminal](<https://gdsfactory.com/gsim/reference/gsim/palace/terminal/index.md>)
- [terminals](<https://gdsfactory.com/gsim/reference/gsim/palace/terminals/index.md>)
- [validation](<https://gdsfactory.com/gsim/reference/gsim/palace/validation/index.md>)
- [api](<https://gdsfactory.com/gsim/reference/gsim/tcad/api/index.md>)
- [device](<https://gdsfactory.com/gsim/reference/gsim/tcad/device/index.md>)
- [doping](<https://gdsfactory.com/gsim/reference/gsim/tcad/doping/index.md>)
- [tcad](<https://gdsfactory.com/gsim/reference/gsim/tcad/index.md>)
- [mesh](<https://gdsfactory.com/gsim/reference/gsim/tcad/mesh/index.md>)
- [results](<https://gdsfactory.com/gsim/reference/gsim/tcad/results/index.md>)
- [runtime](<https://gdsfactory.com/gsim/reference/gsim/tcad/runtime/index.md>)
- [silicon](<https://gdsfactory.com/gsim/reference/gsim/tcad/silicon/index.md>)
- [simulation](<https://gdsfactory.com/gsim/reference/gsim/tcad/simulation/index.md>)
- [validation](<https://gdsfactory.com/gsim/reference/gsim/tcad/validation/index.md>)
- [viz](<https://gdsfactory.com/gsim/reference/gsim/viz/index.md>)

## Releases

- [Changelog](<https://gdsfactory.com/gsim/CHANGELOG/index.md>)