API reference¶

The supported simulation, analysis, cloud, and visualization namespaces, rendered from the installed PhotonHub Python SDK. The SDK is Apache-2.0:

import photonhub as ph

Names shown as ph.x are the top-level surface. Names shown as analysis.x and viz.x come from namespaces imported explicitly:

from photonhub import analysis, viz

Names shown as photonhub.agent_tools.x and photonhub.error_codes.x come from those separately imported modules:

import photonhub.agent_tools
import photonhub.error_codes

Supported namespace policy¶

Coverage includes photonhub, photonhub.library, photonhub.materials, photonhub.cloud, photonhub.study, photonhub.analysis, photonhub.viz, photonhub.agent_tools, and photonhub.error_codes. The inverse-design objects re-exported by photonhub are included too.

The manifest is checked against each covered namespace's __all__. Each export must be rendered once or accounted for as a module, constant, or alias. Rendered objects and their own public Python methods and properties must have docstrings. Inherited framework members, private names, and data attributes are outside that method check.

These pages are generated and committed with generate.py emit. The build runs generate.py check before rendering and fails on stale pages or missing coverage within this policy. 321 symbols documented.

ph.Batch and ph.cloud.Batch are different objects

A few names exist in both the local and the cloud namespace: Batch, submit. They are separate types with separate semantics: the ph. one runs against a local phsolver, the ph.cloud. one against a remote GPU. Both are listed below.

All symbols¶

Symbol	Kind	Documented in
`ph.cloud.account`	function	Cloud client (`ph.cloud`)
`ph.materials.Ag`	attribute	Materials
`ph.materials.Al`	attribute	Materials
`ph.materials.AlN`	attribute	Materials
`ph.Apodization`	class	Monitors
`ph.assemble_gradient`	function	Inverse design
`analysis.assemble_smatrix`	function	S-matrix
`analysis.assert_passive`	function	S-matrix
`analysis.assert_reciprocal`	function	S-matrix
`ph.materials.Au`	attribute	Materials
`ph.auto_mesh`	function	Simulation and grid
`ph.axis_mirror_mismatch`	function	Simulation and grid
`ph.Background`	class	Simulation and grid
`ph.Batch`	class	Running simulations
`ph.cloud.Batch`	class	Cloud client (`ph.cloud`)
`ph.BatchResults`	class	Running simulations
`ph.library.bend`	function	Component library
`ph.Boundaries`	class	Simulation and grid
`ph.Box`	class	Structures and media
`ph.library.bragg_grating`	function	Component library
`ph.BroadbandGradientResult`	class	Inverse design
`ph.BroadbandModeTransmission`	class	Inverse design
`ph.build_adjoint_simulation`	function	Inverse design
`ph.c0`	attribute	Simulation and grid
`ph.materials.CaF2`	attribute	Materials
`ph.cloud.cancel`	function	Cloud client (`ph.cloud`)
`photonhub.agent_tools.Capabilities`	class	Agent tools
`photonhub.agent_tools.capabilities`	function	Agent tools
`ph.carrier_plasma`	function	Structures and media
`analysis.cascade`	function	Eigenmode expansion (EME)
`ph.study.Choices`	class	Design studies
`ph.cloud.CloudConfig`	class	Cloud client (`ph.cloud`)
`ph.cloud.CloudError`	class	Cloud client (`ph.cloud`)
`ph.cloud.CloudJobTimeout`	class	Cloud client (`ph.cloud`)
`ph.cloud.CloudPreflight`	class	Cloud client (`ph.cloud`)
`photonhub.error_codes.CodedError`	class	Error codes
`photonhub.error_codes.CODES`	attribute	Error codes
`analysis.colocated_fields`	function	Far field and diffraction
`analysis.CompletionRejected`	class	Spectra and resonances
`ph.library.Component`	class	Component library
`ph.cloud.configure`	function	Cloud client (`ph.cloud`)
`ph.materials.ConstantIndex`	class	Materials
`photonhub.agent_tools.convergence_report`	function	Agent tools
`photonhub.agent_tools.ConvergenceLocation`	class	Agent tools
`photonhub.agent_tools.ConvergenceSummary`	class	Agent tools
`ph.convert_to_hdf5`	function	Results
`ph.study.corners`	function	Design studies
`ph.library.cosine_taper`	function	Component library
`ph.library.cosine_taper_crossing`	function	Component library
`ph.CostEstimate`	class	Cost estimation
`ph.library.coupler`	function	Component library
`photonhub.agent_tools.CpuOnlyInfo`	class	Agent tools
`ph.cloud.create_api_key`	function	Cloud client (`ph.cloud`)
`ph.library.crossing`	function	Component library
`ph.materials.Cu`	attribute	Materials
`ph.curvature_penalty`	function	Inverse design
`analysis.cvcs_sections`	function	Beams and imported sources
`ph.CW`	class	Sources
`ph.Cylinder`	class	Structures and media
`ph.DesignRegion`	class	Inverse design
`photonhub.agent_tools.DeviceInfo`	class	Agent tools
`analysis.diffraction_orders`	function	Far field and diffraction
`analysis.DiffractionOrders`	class	Far field and diffraction
`ph.Domain`	class	Simulation and grid
`ph.DrudePole`	class	Structures and media
`analysis.eme_convergence_report`	function	Eigenmode expansion (EME)
`analysis.EMEConvergenceReport`	class	Eigenmode expansion (EME)
`analysis.EMEResult`	class	Eigenmode expansion (EME)
`photonhub.agent_tools.EngineStatus`	class	Agent tools
`ph.eps0`	attribute	Simulation and grid
`analysis.equivalence_current_source`	function	Beams and imported sources
`analysis.equivalent_currents`	function	Far field and diffraction
`photonhub.error_codes.error_catalog`	function	Error codes
`photonhub.error_codes.ErrorCode`	class	Error codes
`photonhub.agent_tools.estimate`	function	Agent tools
`ph.cloud.estimate`	function	Cloud client (`ph.cloud`)
`photonhub.agent_tools.EstimateAssumptions`	class	Agent tools
`ph.export_gds`	function	GDSII layout
`viz.export_scene`	function	Visualization (`photonhub.viz`)
`analysis.far_field`	function	Far field and diffraction
`analysis.FarField`	class	Far field and diffraction
`ph.FarFieldMonitor`	class	Monitors
`ph.find_solver`	function	Running simulations
`ph.finite_difference_check`	function	Inverse design
`ph.FiniteDifferenceResult`	class	Inverse design
`analysis.focal_metrics`	function	Beams and imported sources
`analysis.focal_scan`	function	Beams and imported sources
`analysis.FocalMetrics`	class	Beams and imported sources
`analysis.FocalScan`	class	Beams and imported sources
`ph.materials.GaAs`	attribute	Materials
`analysis.gaussian_beam`	function	Beams and imported sources
`analysis.gaussian_beam_source`	function	Beams and imported sources
`analysis.gaussian_mode`	function	Mode sources and monitors
`ph.GaussianBeam`	class	Simulation and grid
`ph.GaussianPulse`	class	Sources
`ph.GDSLayer`	class	GDSII layout
`ph.materials.Ge`	attribute	Materials
`ph.materials.get`	function	Materials
`ph.cloud.get_config`	function	Cloud client (`ph.cloud`)
`photonhub.agent_tools.get_schema`	function	Agent tools
`ph.cloud.gpus`	function	Cloud client (`ph.cloud`)
`ph.graded_primary_spacings`	function	Simulation and grid
`ph.GradedMesh`	class	Simulation and grid
`ph.GradedMeshAxis`	class	Simulation and grid
`ph.GradientResult`	class	Inverse design
`ph.study.grid`	function	Design studies
`ph.cloud.HttpClient`	class	Cloud client (`ph.cloud`)
`ph.integrations.gdsfactory.import_component`	function	gdsfactory adapter
`analysis.import_field`	function	Beams and imported sources
`ph.import_gds`	function	GDSII layout
`analysis.import_source`	function	Beams and imported sources
`ph.integrations.gdsfactory.ImportedComponent`	class	gdsfactory adapter
`ph.integrations.gdsfactory.ImportedLevel`	class	gdsfactory adapter
`ph.materials.InP`	attribute	Materials
`viz.interactive_field`	function	Visualization (`photonhub.viz`)
`viz.interactive_preview`	function	Visualization (`photonhub.viz`)
`analysis.interface_smatrix`	function	Eigenmode expansion (EME)
`analysis.InterfaceDiagnostics`	class	Eigenmode expansion (EME)
`analysis.interpolate_mode`	function	Beams and imported sources
`analysis.interpolate_plane`	function	Beams and imported sources
`analysis.is_passive`	function	S-matrix
`analysis.is_reciprocal`	function	S-matrix
`photonhub.agent_tools.Issue`	class	Agent tools
`photonhub.error_codes.issue`	function	Error codes
`photonhub.error_codes.issue_from_finding`	function	Error codes
`ph.Job`	class	Running simulations
`ph.cloud.job_status`	function	Cloud client (`ph.cloud`)
`ph.study.latin_hypercube`	function	Design studies
`ph.materials.LiNbO3_e`	attribute	Materials
`ph.materials.LiNbO3_o`	attribute	Materials
`ph.cloud.list_jobs`	function	Cloud client (`ph.cloud`)
`ph.study.load`	function	Design studies
`photonhub.agent_tools.LocalEstimate`	class	Agent tools
`ph.materials.LorentzFit`	class	Materials
`ph.LorentzPole`	class	Structures and media
`analysis.match_modes`	function	Mode sources and monitors
`ph.materials.Material`	class	Materials
`ph.integrations.gdsfactory.MATERIAL_ALIASES`	attribute	gdsfactory adapter
`ph.materials.MATERIALS`	attribute	Materials
`ph.Medium`	class	Structures and media
`ph.Mesh`	class	Simulation and grid
`ph.MeshOverride`	class	Simulation and grid
`ph.materials.MgF2_e`	attribute	Materials
`ph.materials.MgF2_o`	attribute	Materials
`analysis.Mode`	class	Mode solving
`analysis.mode_amplitude`	function	Mode sources and monitors
`analysis.mode_bank_on_cross_section`	function	Mode solving
`analysis.mode_decomposition`	function	Mode sources and monitors
`analysis.mode_launch`	function	Mode sources and monitors
`analysis.mode_monitor`	function	Mode sources and monitors
`analysis.mode_overlap`	function	Mode sources and monitors
`analysis.mode_overlap_matrix`	function	Mode sources and monitors
`analysis.mode_source`	function	Mode sources and monitors
`analysis.mode_source_vector`	function	Mode sources and monitors
`analysis.mode_transmission`	function	Mode sources and monitors
`ph.mode_window_um`	function	Simulation and grid
`analysis.ModeBank`	type alias	Mode sources and monitors
`analysis.ModeMonitor`	class	Mode sources and monitors
`analysis.ModeOverlap`	class	Mode sources and monitors
`ph.ModePort`	class	Monitors
`ph.ModePower`	class	Inverse design
`ph.ModeSolveProvenance`	class	Sources
`analysis.ModeSolver`	class	Mode solving
`ph.ModeSource`	class	Sources
`ph.ModeTransmission`	class	Inverse design
`ph.study.monte_carlo`	function	Design studies
`ph.optimize`	function	Inverse design
`ph.optimize_parametric`	function	Inverse design
`ph.OptimizeResult`	class	Inverse design
`ph.parametric_finite_difference_check`	function	Inverse design
`ph.parametric_value_and_gradient`	function	Inverse design
`ph.ParametricGradientResult`	class	Inverse design
`ph.ParametricResult`	class	Inverse design
`analysis.passivity_violation`	function	S-matrix
`ph.PermittivityArray`	class	Structures and media
`ph.perturbed_medium`	function	Structures and media
`ph.study.plan`	function	Design studies
`ph.integrations.gdsfactory.plan_component_smatrix`	function	gdsfactory adapter
`analysis.plan_smatrix`	function	S-matrix
`ph.PlaneWave`	class	Sources
`viz.plot`	function	Visualization (`photonhub.viz`)
`viz.plot_3d`	function	Visualization (`photonhub.viz`)
`viz.plot_comparison`	function	Visualization (`photonhub.viz`)
`viz.plot_far_field_cut`	function	Visualization (`photonhub.viz`)
`viz.plot_far_field_map`	function	Visualization (`photonhub.viz`)
`viz.plot_field`	function	Visualization (`photonhub.viz`)
`viz.plot_index`	function	Visualization (`photonhub.viz`)
`viz.plot_mode`	function	Visualization (`photonhub.viz`)
`viz.plot_overlap`	function	Visualization (`photonhub.viz`)
`viz.plot_source_time`	function	Visualization (`photonhub.viz`)
`viz.plot_spectrum`	function	Visualization (`photonhub.viz`)
`ph.materials.PMMA`	attribute	Materials
`ph.PointDipole`	class	Sources
`ph.PointIntensity`	class	Inverse design
`ph.study.points`	function	Design studies
`ph.Polygon`	class	Structures and media
`ph.PolygonProfile`	class	Inverse design
`ph.materials.Polynomial`	class	Materials
`ph.Port`	class	Simulation and grid
`ph.library.Port`	class	Component library
`ph.PortMode`	class	Monitors
`ph.PowerMonitor`	class	Monitors
`ph.cloud.preflight`	function	Cloud client (`ph.cloud`)
`ph.ProfileMonitor`	class	Monitors
`analysis.propagate_plane`	function	Beams and imported sources
`analysis.propagation_smatrix`	function	Eigenmode expansion (EME)
`ph.quote`	function	Cost estimation
`ph.read_gds_cell_names`	function	GDSII layout
`analysis.read_touchstone`	function	S-matrix
`analysis.reciprocity_error`	function	S-matrix
`analysis.rectangular_base_section`	function	Eigenmode expansion (EME)
`analysis.rectangular_waveguide`	function	Mode solving
`analysis.reflection`	function	Mode sources and monitors
`analysis.reflection_spectrum`	function	Mode sources and monitors
`viz.render_field_slice`	function	Visualization (`photonhub.viz`)
`viz.render_slice`	function	Visualization (`photonhub.viz`)
`analysis.reorder_to_tracks`	function	Mode sources and monitors
`ph.cloud.reset`	function	Cloud client (`ph.cloud`)
`analysis.ResonanceAnalysis`	class	Spectra and resonances
`photonhub.agent_tools.result_summary`	function	Agent tools
`photonhub.agent_tools.ResultMonitor`	class	Agent tools
`photonhub.agent_tools.ResultSummary`	class	Agent tools
`ph.cloud.resume`	function	Cloud client (`ph.cloud`)
`ph.library.ring`	function	Component library
`ph.cloud.run`	function	Cloud client (`ph.cloud`)
`ph.study.run`	function	Design studies
`ph.integrations.gdsfactory.run_component_smatrix`	function	gdsfactory adapter
`analysis.run_eme`	function	Eigenmode expansion (EME)
`analysis.run_eme_band`	function	Eigenmode expansion (EME)
`ph.run_local`	function	Running simulations
`ph.cloud.run_quoted`	function	Cloud client (`ph.cloud`)
`analysis.run_smatrix`	function	S-matrix
`ph.RunResult`	class	Results
`ph.RunSpec`	class	Simulation and grid
`photonhub.agent_tools.SafetyInfo`	class	Agent tools
`analysis.sample_cross_section_kfj`	function	Mode solving
`analysis.sample_staggered_eps`	function	Mode solving
`ph.study.Samples`	class	Design studies
`ph.materials.Sapphire`	attribute	Materials
`ph.study.save`	function	Design studies
`analysis.scalar_beam`	function	Beams and imported sources
`viz.Scene`	class	Visualization (`photonhub.viz`)
`photonhub.agent_tools.SchemaInfo`	class	Agent tools
`photonhub.agent_tools.SecondsRange`	class	Agent tools
`analysis.Section`	class	Eigenmode expansion (EME)
`analysis.select_resonances`	function	Spectra and resonances
`ph.materials.Sellmeier`	class	Materials
`viz.sharp_inline_figures`	function	Visualization (`photonhub.viz`)
`ph.materials.Si`	attribute	Materials
`ph.materials.Si3N4`	attribute	Materials
`ph.library.SILICON`	attribute	Component library
`ph.Simulation`	class	Simulation and grid
`ph.SimulationMismatchError`	class	Results
`ph.materials.SiO2`	attribute	Materials
`analysis.smatrix`	function	S-matrix
`analysis.smatrix_checks`	function	S-matrix
`analysis.smatrix_model`	function	S-matrix
`analysis.SMatrixChecks`	class	S-matrix
`analysis.SMatrixModel`	class	S-matrix
`analysis.SMatrixPlan`	class	S-matrix
`analysis.SMatrixPort`	class	S-matrix
`analysis.SMatrixResult`	class	S-matrix
`ph.SnapshotMonitor`	class	Monitors
`analysis.solve_mode_bank`	function	Mode sources and monitors
`analysis.solve_mode_on_cross_section`	function	Mode solving
`analysis.solve_modes_by_freq`	function	Mode sources and monitors
`analysis.solve_yee_eme_basis`	function	Mode solving
`analysis.solve_yee_mode`	function	Mode solving
`analysis.solve_yee_mode_bank`	function	Mode solving
`analysis.solve_yee_multimode_bank`	function	Mode solving
`analysis.solve_yee_port_mode_bank`	function	Mode solving
`photonhub.agent_tools.SolverInfo`	class	Agent tools
`ph.SolverRunError`	class	Running simulations
`ph.study.Span`	class	Design studies
`ph.SpatialMap`	class	Structures and media
`ph.spec_sha256`	function	Running simulations
`analysis.SpectrumCompleter`	class	Spectra and resonances
`ph.Sphere`	class	Structures and media
`ph.library.spline_taper_crossing`	function	Component library
`ph.library.spline_width_profile`	function	Component library
`analysis.SPort`	class	S-matrix
`analysis.star_product`	function	Eigenmode expansion (EME)
`ph.library.straight`	function	Component library
`ph.Structure`	class	Structures and media
`ph.study.StudyPlan`	class	Design studies
`ph.cloud.submit`	function	Cloud client (`ph.cloud`)
`ph.submit`	function	Running simulations
`ph.cloud.submit_quoted`	function	Cloud client (`ph.cloud`)
`ph.materials.TabulatedNK`	class	Materials
`ph.library.taper`	function	Component library
`ph.TFSFBox`	class	Sources
`ph.thermo_optic_index`	function	Structures and media
`analysis.thin_lens_beam`	function	Beams and imported sources
`analysis.thin_lens_source`	function	Beams and imported sources
`ph.TimeMonitor`	class	Monitors
`ph.materials.TiO2`	attribute	Materials
`analysis.track_modes`	function	Mode sources and monitors
`analysis.TrackingResult`	class	Mode sources and monitors
`analysis.transmission`	function	Mode sources and monitors
`analysis.transmission_spectrum`	function	Mode sources and monitors
`ph.TransmissionPort`	class	Inverse design
`analysis.transverse_overlap`	function	Mode sources and monitors
`analysis.unfold_symmetry`	function	Far field and diffraction
`ph.materials.uniaxial_medium`	function	Materials
`ph.UniformMesh`	class	Simulation and grid
`ph.materials.Vacuum`	attribute	Materials
`photonhub.agent_tools.validate_spec`	function	Agent tools
`photonhub.agent_tools.ValidationReport`	class	Agent tools
`ph.value_and_gradient`	function	Inverse design
`analysis.vector_modal_fields`	function	Mode sources and monitors
`analysis.VectorMode`	class	Mode solving
`analysis.VectorModeSolver`	class	Mode solving
`analysis.waveguide_section`	function	Eigenmode expansion (EME)
`analysis.WaveguideModes`	class	Mode solving
`ph.cloud.whoami`	function	Cloud client (`ph.cloud`)
`ph.WidthProfile`	class	Inverse design
`analysis.window_min_face_bcs`	function	Mode solving
`analysis.write_touchstone`	function	S-matrix
`ph.library.y_branch`	function	Component library
`ph.study.yield_fraction`	function	Design studies
`ph.study.YieldEstimate`	class	Design studies

Not rendered here¶

ph.SCHEMA_VERSION is a version string rather than an API object; it is explained in Schema and versioning. ph.library, ph.materials, ph.cloud, ph.study, ph.inverse_design, ph.perturbation, photonhub.analysis, and photonhub.viz are modules. Each has its own reference page or section above. ph.gpus is an alias for the rendered ph.cloud.gpus. ph.__version__ is package version metadata and is excluded from the symbol count.

photonhub.replicate and photonhub.solver_install are repository workflow helpers. They are not supported reference namespaces in this policy. Their exports are not included in the count or completeness check. Solver setup for users is covered by Install and Headless solver. Other SDK submodules are implementation details unless their objects are re-exported in a covered namespace.