added log and fix pylint

docs/api.rst

@@ -27,6 +27,7 @@ Methods
    Simulation.plot_monitors
    Simulation.plot_symmetries
    Simulation.plot_pml
+   Simulation.plot_grid
    Simulation.grid
    Simulation.dt
    Simulation.tmesh
@@ -84,6 +85,7 @@ Geometry
    Sphere
    Cylinder
    PolySlab
+   PolySlab.from_gdspy
 
 Methods
 -------
@@ -259,7 +261,9 @@ Log
 .. autosummary::
    :toctree: _autosummary/
 
-   logging_level
+   log
+   set_logging_level
+   set_logging_file
 
 
 Submitting Simulations

test_static.sh

@@ -10,6 +10,7 @@ pytest -rA tests/test_plugins.py
 
 pytest --doctest-modules tidy3d \
 --ignore=tidy3d/__main__.py \
+--ignore=tidy3d/log.py \
 --ignore=tidy3d/components/base.py \
 --ignore=tidy3d/web/webapi.py \
 --ignore=tidy3d/web/container.py \

tidy3d/__init__.py

@@ -53,7 +53,7 @@
 from .material_library import material_library
 
 # logging
-from .log import log, logging_level
+from .log import log, set_logging_level, set_logging_file
 
 # for docs
 from .components.medium import AbstractMedium

tidy3d/components/data.py

@@ -106,6 +106,7 @@ class MonitorData(Tidy3dData, ABC):
 
     @property
     def data(self) -> xr.DataArray:
+        # pylint:disable=line-too-long
         """Returns an xarray representation of the montitor data.
 
         Returns
@@ -114,6 +115,7 @@ def data(self) -> xr.DataArray:
             Representation of the monitor data using xarray.
             For more details refer to `xarray's Documentaton <http://xarray.pydata.org/en/stable/generated/xarray.DataArray.html>`_.
         """
+        # pylint:enable=line-too-long
 
         data_dict = self.dict()
         coords = {dim: data_dict[dim] for dim in self._dims}
@@ -187,6 +189,7 @@ class CollectionData(Tidy3dData):
 
     @property
     def data(self) -> xr.Dataset:
+        # pylint:disable=line-too-long
         """For field quantities, store a single xarray DataArray for each ``field``.
         These all go in a single xarray Dataset, which keeps track of the shared coords.
 
@@ -196,6 +199,7 @@ def data(self) -> xr.Dataset:
             Representation of the underlying data using xarray.
             For more details refer to `xarray's Documentaton <http://xarray.pydata.org/en/stable/generated/xarray.Dataset.html>`_.
         """
+        # pylint:enable=line-too-long
         data_arrays = {name: arr.data for name, arr in self.data_dict.items()}
 
         # make an xarray dataset

tidy3d/components/geometry.py

@@ -1,3 +1,4 @@
+# pylint:disable=too-many-lines
 """Defines spatial extent of objects."""
 
 from abc import ABC, abstractmethod
@@ -65,7 +66,8 @@ def intersections(self, x: float = None, y: float = None, z: float = None) -> Li
         -------
         List[shapely.geometry.base.BaseGeometry]
             List of 2D shapes that intersect plane.
-            For more details refer to `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
+            For more details refer to
+            `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
         """
 
     def intersects(self, other) -> bool:
@@ -180,6 +182,7 @@ def _pop_bounds(self, axis: Axis) -> Tuple[Coordinate2D, Tuple[Coordinate2D, Coo
     def plot(
         self, x: float = None, y: float = None, z: float = None, ax: Ax = None, **patch_kwargs
     ) -> Ax:
+        # pylint:disable=line-too-long
         """Plot geometry cross section at single (x,y,z) coordinate.
 
         Parameters
@@ -202,6 +205,7 @@ def plot(
         matplotlib.axes._subplots.Axes
             The supplied or created matplotlib axes.
         """
+        # pylint:disable=line-too-long
 
         # find shapes that intersect self at plane
         axis, position = self._parse_xyz_kwargs(x=x, y=y, z=z)
@@ -373,7 +377,8 @@ def intersections(self, x: float = None, y: float = None, z: float = None):
         -------
         List[shapely.geometry.base.BaseGeometry]
             List of 2D shapes that intersect plane.
-            For more details refer to `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
+            For more details refer to
+        `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
         """
         axis, position = self._parse_xyz_kwargs(x=x, y=y, z=z)
         if axis == self.axis:
@@ -391,7 +396,8 @@ def _intersections_normal(self) -> list:
         -------
         List[shapely.geometry.base.BaseGeometry]
             List of 2D shapes that intersect plane.
-            For more details refer to `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
+            For more details refer to
+            `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
         """
 
     @abstractmethod
@@ -409,7 +415,8 @@ def _intersections_side(self, position: float, axis: Axis) -> list:
         -------
         List[shapely.geometry.base.BaseGeometry]
             List of 2D shapes that intersect plane.
-            For more details refer to `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
+            For more details refer to
+            `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
         """
 
     @property
@@ -519,7 +526,8 @@ def intersections(self, x: float = None, y: float = None, z: float = None):
         -------
         List[shapely.geometry.base.BaseGeometry]
             List of 2D shapes that intersect plane.
-            For more details refer to `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
+            For more details refer to
+            `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
         """
         axis, position = self._parse_xyz_kwargs(x=x, y=y, z=z)
         z0, (x0, y0) = self.pop_axis(self.center, axis=axis)
@@ -636,7 +644,8 @@ def intersections(self, x: float = None, y: float = None, z: float = None):
         -------
         List[shapely.geometry.base.BaseGeometry]
             List of 2D shapes that intersect plane.
-            For more details refer to `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
+            For more details refer to
+            `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
         """
         axis, position = self._parse_xyz_kwargs(x=x, y=y, z=z)
         z0, (x0, y0) = self.pop_axis(self.center, axis=axis)
@@ -688,7 +697,8 @@ def _intersections_normal(self):
         -------
         List[shapely.geometry.base.BaseGeometry]
             List of 2D shapes that intersect plane.
-            For more details refer to `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
+            For more details refer to
+            `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
         """
         _, (x0, y0) = self.pop_axis(self.center, axis=self.axis)
         return [Point(x0, y0).buffer(self.radius)]
@@ -707,7 +717,8 @@ def _intersections_side(self, position, axis):
         -------
         List[shapely.geometry.base.BaseGeometry]
             List of 2D shapes that intersect plane.
-            For more details refer to `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
+            For more details refer to
+            `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
         """
         z0_axis, _ = self.pop_axis(self.center, axis=self.axis)
         intersect_dist = self._intersect_dist(position, z0_axis)
@@ -912,7 +923,8 @@ def _intersections_normal(self):
         -------
         List[shapely.geometry.base.BaseGeometry]
             List of 2D shapes that intersect plane.
-            For more details refer to `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
+            For more details refer to
+            `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
         """
         return [Polygon(self.vertices)]
 
@@ -930,7 +942,8 @@ def _intersections_side(self, position, axis) -> list:  # pylint:disable=too-man
         -------
         List[shapely.geometry.base.BaseGeometry]
             List of 2D shapes that intersect plane.
-            For more details refer to `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
+            For more details refer to
+            `Shapely's Documentaton <https://shapely.readthedocs.io/en/stable/project.html>`_.
         """
 
         z0, _ = self.pop_axis(self.center, axis=self.axis)

tidy3d/components/monitor.py

@@ -20,7 +20,7 @@ class Monitor(Box, ABC):
     _name_validator = validate_name_str()
 
     @add_ax_if_none
-    def plot( #pylint:disable=duplicate-code
+    def plot(  # pylint:disable=duplicate-code
         self, x: float = None, y: float = None, z: float = None, ax: Ax = None, **kwargs
     ) -> Ax:
         """Plot the monitor geometry on a cross section plane.