From 3a6312f66e826efdd8b6c8a567dd9157d0daef01 Mon Sep 17 00:00:00 2001 From: dbochkov-flexcompute Date: Tue, 26 Mar 2024 21:48:53 -0500 Subject: [PATCH] add unstructured datasets in docs --- docs/api/heat/output_data.rst | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/docs/api/heat/output_data.rst b/docs/api/heat/output_data.rst index ac1d44169..be6bc3c59 100644 --- a/docs/api/heat/output_data.rst +++ b/docs/api/heat/output_data.rst @@ -3,8 +3,19 @@ Output Data ------------- + +Heat Simulation Data +^^^^^^^^^^^^^^^^^^^^ + +.. autosummary:: + :toctree: ../_autosummary/ + :template: module.rst + + tidy3d.HeatSimulationData + + Monitor Data -^^^^^^^^^^^^^^^ +^^^^^^^^^^^^ .. autosummary:: :toctree: ../_autosummary/ @@ -13,11 +24,24 @@ Monitor Data tidy3d.TemperatureData -Heat Simulation Data -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Unstructured Data Classes +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autosummary:: + :toctree: ../_autosummary/ + :template: module.rst + + tidy3d.TriangularGridDataset + tidy3d.TetrahedralGridDataset + + +Individual Datasets +^^^^^^^^^^^^^^^^^^^ .. autosummary:: :toctree: ../_autosummary/ :template: module.rst - tidy3d.HeatSimulationData \ No newline at end of file + tidy3d.PointDataArray + tidy3d.CellDataArray + tidy3d.IndexedDataArray