Skip to content

Commit 6a81855

Browse files
committed
fix doctests
1 parent 87babea commit 6a81855

2 files changed

Lines changed: 26 additions & 21 deletions

File tree

tidy3d/components/medium/anisotropic.py

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -556,20 +556,22 @@ class CustomAnisotropicMedium(AbstractCustomMedium, AnisotropicMedium):
556556
557557
Example
558558
-------
559+
>>> import numpy as np
560+
>>> import tidy3d as td
559561
>>> Nx, Ny, Nz = 10, 9, 8
560562
>>> x = np.linspace(-1, 1, Nx)
561563
>>> y = np.linspace(-1, 1, Ny)
562564
>>> z = np.linspace(-1, 1, Nz)
563565
>>> coords = dict(x=x, y=y, z=z)
564-
>>> permittivity= SpatialDataArray(np.ones((Nx, Ny, Nz)), coords=coords)
565-
>>> conductivity= SpatialDataArray(np.ones((Nx, Ny, Nz)), coords=coords)
566-
>>> medium_xx = CustomMedium(permittivity=permittivity, conductivity=conductivity)
567-
>>> medium_yy = CustomMedium(permittivity=permittivity, conductivity=conductivity)
568-
>>> d_epsilon = SpatialDataArray(np.random.random((Nx, Ny, Nz)), coords=coords)
569-
>>> f = SpatialDataArray(1+np.random.random((Nx, Ny, Nz)), coords=coords)
570-
>>> delta = SpatialDataArray(np.random.random((Nx, Ny, Nz)), coords=coords)
571-
>>> medium_zz = CustomLorentz(eps_inf=permittivity, coeffs=[(d_epsilon,f,delta),])
572-
>>> anisotropic_dielectric = CustomAnisotropicMedium(xx=medium_xx, yy=medium_yy, zz=medium_zz)
566+
>>> permittivity= td.SpatialDataArray(np.ones((Nx, Ny, Nz)), coords=coords)
567+
>>> conductivity= td.SpatialDataArray(np.ones((Nx, Ny, Nz)), coords=coords)
568+
>>> medium_xx = td.CustomMedium(permittivity=permittivity, conductivity=conductivity)
569+
>>> medium_yy = td.CustomMedium(permittivity=permittivity, conductivity=conductivity)
570+
>>> d_epsilon = td.SpatialDataArray(np.random.random((Nx, Ny, Nz)), coords=coords)
571+
>>> f = td.SpatialDataArray(1+np.random.random((Nx, Ny, Nz)), coords=coords)
572+
>>> delta = td.SpatialDataArray(np.random.random((Nx, Ny, Nz)), coords=coords)
573+
>>> medium_zz = td.CustomLorentz(eps_inf=permittivity, coeffs=[(d_epsilon,f,delta),])
574+
>>> anisotropic_dielectric = td.CustomAnisotropicMedium(xx=medium_xx, yy=medium_yy, zz=medium_zz)
573575
574576
See Also
575577
--------
@@ -772,20 +774,22 @@ class CustomAnisotropicMediumInternal(CustomAnisotropicMedium):
772774
773775
Example
774776
-------
777+
>>> import numpy as np
778+
>>> import tidy3d as td
775779
>>> Nx, Ny, Nz = 10, 9, 8
776780
>>> X = np.linspace(-1, 1, Nx)
777781
>>> Y = np.linspace(-1, 1, Ny)
778782
>>> Z = np.linspace(-1, 1, Nz)
779783
>>> coords = dict(x=X, y=Y, z=Z)
780-
>>> permittivity= SpatialDataArray(np.ones((Nx, Ny, Nz)), coords=coords)
781-
>>> conductivity= SpatialDataArray(np.ones((Nx, Ny, Nz)), coords=coords)
782-
>>> medium_xx = CustomMedium(permittivity=permittivity, conductivity=conductivity)
783-
>>> medium_yy = CustomMedium(permittivity=permittivity, conductivity=conductivity)
784-
>>> d_epsilon = SpatialDataArray(np.random.random((Nx, Ny, Nz)), coords=coords)
785-
>>> f = SpatialDataArray(1+np.random.random((Nx, Ny, Nz)), coords=coords)
786-
>>> delta = SpatialDataArray(np.random.random((Nx, Ny, Nz)), coords=coords)
787-
>>> medium_zz = CustomLorentz(eps_inf=permittivity, coeffs=[(d_epsilon,f,delta),])
788-
>>> anisotropic_dielectric = CustomAnisotropicMedium(xx=medium_xx, yy=medium_yy, zz=medium_zz)
784+
>>> permittivity= td.SpatialDataArray(np.ones((Nx, Ny, Nz)), coords=coords)
785+
>>> conductivity= td.SpatialDataArray(np.ones((Nx, Ny, Nz)), coords=coords)
786+
>>> medium_xx = td.CustomMedium(permittivity=permittivity, conductivity=conductivity)
787+
>>> medium_yy = td.CustomMedium(permittivity=permittivity, conductivity=conductivity)
788+
>>> d_epsilon = td.SpatialDataArray(np.random.random((Nx, Ny, Nz)), coords=coords)
789+
>>> f = td.SpatialDataArray(1+np.random.random((Nx, Ny, Nz)), coords=coords)
790+
>>> delta = td.SpatialDataArray(np.random.random((Nx, Ny, Nz)), coords=coords)
791+
>>> medium_zz = td.CustomLorentz(eps_inf=permittivity, coeffs=[(d_epsilon,f,delta),])
792+
>>> anisotropic_dielectric = td.CustomAnisotropicMedium(xx=medium_xx, yy=medium_yy, zz=medium_zz)
789793
"""
790794

791795
xx: Union[IsotropicCustomMediumInternalType, CustomMedium] = pd.Field(

tidy3d/components/medium/nonlinear.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -528,9 +528,10 @@ class NonlinearSpec(ABC, Tidy3dBaseModel):
528528
529529
Example
530530
-------
531-
>>> nonlinear_susceptibility = NonlinearSusceptibility(chi3=1)
532-
>>> nonlinear_spec = NonlinearSpec(models=[nonlinear_susceptibility])
533-
>>> medium = Medium(permittivity=2, nonlinear_spec=nonlinear_spec)
531+
>>> import tidy3d as td
532+
>>> nonlinear_susceptibility = td.NonlinearSusceptibility(chi3=1)
533+
>>> nonlinear_spec = td.NonlinearSpec(models=[nonlinear_susceptibility])
534+
>>> medium = td.Medium(permittivity=2, nonlinear_spec=nonlinear_spec)
534535
"""
535536

536537
models: Tuple[NonlinearModelType, ...] = pd.Field(

0 commit comments

Comments
 (0)