Skip to content

Commit 9091008

Browse files
🎨 Add GUI docs gallery, job ad
1 parent 13de5f2 commit 9091008

File tree

9 files changed

+105
-22
lines changed

9 files changed

+105
-22
lines changed

docs/_static/img/gui_overview.png

419 KB
Loading
179 KB
Loading
34.5 KB
Loading

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@
106106
"sphinx.ext.todo",
107107
"sphinx.ext.viewcode", # Add a link to the Python source code for classes, functions etc.
108108
"sphinx_copybutton",
109+
"sphinx_design",
109110
"sphinx_favicon",
110111
"sphinx_sitemap",
111112
"sphinx_tabs.tabs",
@@ -188,6 +189,7 @@
188189
}
189190
myst_enable_extensions = [
190191
"amsmath",
192+
"colon_fence",
191193
"dollarmath",
192194
]
193195
nbsphinx_allow_errors = True # Continue through Jupyter errors

docs/index.rst

Lines changed: 67 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -166,25 +166,62 @@ This will produce the following plot, which visualizes the electromagnetic field
166166
:width: 1200
167167

168168

169-
You can now postprocess simulation data using the same python session, or view the results of this simulation on our web-based `graphical user interface <https://tidy3d.simulation.cloud>`_.
169+
You can now postprocess simulation data using the same python session, or view the results of this simulation on our web-based `graphical user interface (GUI) <https://tidy3d.simulation.cloud>`_.
170170

171171
.. `TODO: open example in colab <https://github.com/flexcompute/tidy3d>`_
172172
173173
174+
Our Ecosystem
175+
=======================
176+
177+
``tidy3d`` is part of an interoperable ecosystem of electromagnetic design tools. You can interface with the tools through the python APIs and the graphical user interfaces.
178+
179+
.. grid:: 3
180+
:gutter: 2
181+
182+
.. grid-item-card::
183+
:img-top: _static/img/gui_overview.png
184+
:link: https://www.flexcompute.com/tidy3d/learning-center/tidy3d-gui/
185+
:text-align: center
186+
:padding: 1
187+
188+
Online Learning Center
189+
+++
190+
**Tidy3D GUI**
191+
192+
.. grid-item-card::
193+
:img-top: _static/img/photonforge_overview.png
194+
:link: https://docs.flexcompute.com/projects/photonforge/en/latest/
195+
:text-align: center
196+
:padding: 1
197+
198+
Photonic Integrated Circuits Design
199+
+++
200+
**Photonforge**
201+
202+
.. grid-item-card::
203+
:img-top: _static/img/simcloud_overview.png
204+
:link: https://tidy3d.simulation.cloud
205+
:text-align: center
206+
:padding: 1
207+
208+
Access your GUI & account management.
209+
+++
210+
**SimCloud**
211+
212+
174213
Further Information
175214
====================
176215

177-
.. toctree::
178-
:maxdepth: 2
179216

180-
install
181-
lectures/index
182-
notebooks/docs/index
183-
faq/docs/index
184-
api/index
185-
development/index
186-
changelog
187-
About our Solver <https://www.flexcompute.com/tidy3d/solver/>
217+
Join Our Team
218+
-------------
219+
220+
Do you enjoy using ``tidy3d`` or ``photonforge``? Do you want to help us create the best electromagnetic design tools? We are looking for talented developers to join our team.
221+
222+
A good way to get an interview with us is to fix an open issue within our `open-source python client. <https://github.com/flexcompute/tidy3d/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22>`_ Choose a task where you can feel you can demonstrate your skillset, and get us involved whilst you implement it for feedback and to see how it goes working together. If you don't know where to start, we recommend the issues labelled "good first issue".
223+
224+
We look forward to your contributions!
188225

189226

190227
Github Repositories
@@ -202,8 +239,25 @@ Github Repositories
202239
* - FAQ Source Code
203240
- https://github.com/flexcompute/tidy3d-faq
204241

205-
These repositories are the a very good way to interact with the relevant tool developers.
206-
We encourage you to ask questions or request features through the "Discussions" or "Issues" tabs of each repository accordingly.
242+
These repositories are a very good way to interact with the relevant tool developers. We encourage you to ask questions or request features through the "Discussions" or "Issues" tabs of each repository accordingly.
243+
244+
245+
Contents
246+
---------
247+
248+
.. toctree::
249+
:maxdepth: 2
250+
251+
install
252+
lectures/index
253+
notebooks/docs/index
254+
faq/docs/index
255+
api/index
256+
GUI <https://www.flexcompute.com/tidy3d/learning-center/tidy3d-gui/>
257+
Photonforge <https://docs.flexcompute.com/projects/photonforge/en/latest/>
258+
development/index
259+
changelog
260+
About our Solver <https://www.flexcompute.com/tidy3d/solver/>
207261

208262

209263

docs/install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Getting Started
99

1010
Before using Tidy3D, you must first `sign up <https://tidy3d.simulation.cloud/signup>`_ for a user account.
1111

12-
By signing up for a free account, you can obtain an API key `here <https://tidy3d.simulation.cloud/account?tab=apikey>`_. You can also `manage your simulation jobs <https://tidy3d.simulation.cloud/folders>`_ and access `graphic user interface <https://tidy3d.simulation.cloud/workbench?taskId=pa-94c49911-132d-48bc-8ec0-f0a4e55140a3>`_ if needed.
12+
By signing up for a free account, you can obtain an API key `here <https://tidy3d.simulation.cloud/account?tab=apikey>`_. You can also `manage your simulation jobs <https://tidy3d.simulation.cloud/folders>`_ and access `graphic user interface (GUI) <https://tidy3d.simulation.cloud/workbench?taskId=pa-94c49911-132d-48bc-8ec0-f0a4e55140a3>`_ if needed.
1313

1414
Managing API Keys
1515
------------------

docs/notebooks

Submodule notebooks updated 234 files

poetry.lock

Lines changed: 31 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ pydata-sphinx-theme = { version = ">=0.13.3", optional = true }
109109
# divparams = {optional = true, git = "https://github.com/daquinteroflex/sphinxcontrib-divparams.git"} # TODO FIX
110110
tmm = { version = "*", optional = true }
111111
grcwa = { version = "*", optional = true }
112+
sphinx-design = { version = "*", optional = true }
112113
sphinx-favicon = { version = "*", optional = true }
113114
sphinx-sitemap = { version = ">=2.5.1", optional = true }
114115
sphinx-notfound-page = { version = "*", optional = true }
@@ -165,6 +166,7 @@ dev = [
165166
'signac',
166167
'sphinx',
167168
'sphinx-book-theme',
169+
'sphinx-design',
168170
'sphinx-copybutton',
169171
'sphinx-favicon',
170172
'sphinx-notfound-page',
@@ -187,6 +189,7 @@ docs = [
187189
"nbsphinx",
188190
"ipython",
189191
"divparams",
192+
'sphinx-design',
190193
"sphinx-copybutton",
191194
'sphinx-favicon',
192195
"sphinx-book-theme",

0 commit comments

Comments
 (0)