Skip to content

Commit de7dcca

Browse files
authored
Update README.md
1 parent da11bc3 commit de7dcca

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

README.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,23 @@
110110
- [x] command line interface to submit yaml or json.
111111
---
112112

113+
#### Visualization
114+
- [x] write all visuaization routines
115+
- [x] MonitorData
116+
- [x] Basic sliding window for cross section.
117+
- [x] Structure cross section
118+
- [x] Simulation epsilon discretization from structure polygons.
119+
- [x] Medium-aware structure / simulation plotting.
120+
- [x] Add Monitor / Source plotting
121+
- [x] Visualize symmetry in ``Simulation.plot``
122+
- [x] Add "plot" to all tidy3d objects.
123+
- [x] source time
124+
- [x] medium
125+
- [x] sampler
126+
- [x] Overlay structures onto fields.
127+
- [x] add .plot method to `SimulationData`
128+
---
129+
113130
#### Solver Integration
114131

115132
- [x] Add version to simulation.json
@@ -118,14 +135,15 @@
118135
- [x] IO SimulationData
119136
- [ ] Process Simulation to solver inputs. (momchil)
120137
- [ ] Write solver outputs to SimulationData. (momchil)
121-
- [ ] Convert to old .json conversion to use old solver code?
138+
- [x] Convert to old .json conversion to use old solver code?
122139
- [ ] Test test test.
123140
---
124141

125142
#### Web Integration (requires solver integration)
126-
- [ ] refactor webapi <- can do without integration?
143+
- [ ] refactor webapi using conversion.
127144
- [ ] add http / authentication etc.
128-
- [ ] set up so that daemon recgonizes new json files.
145+
- [ ] Nice web api plotting / progressbars using `rich`.
146+
- [ ] Set up so that daemon recgonizes new json files.
129147
- [ ] Test test test.
130148
---
131149

@@ -137,23 +155,6 @@
137155
- [ ] Handling client-side discretization properly.
138156
---
139157

140-
#### Visualization
141-
- [x] write all visuaization routines
142-
- [x] MonitorData
143-
- [x] Basic sliding window for cross section.
144-
- [x] Structure cross section
145-
- [x] Simulation epsilon discretization from structure polygons.
146-
- [x] Medium-aware structure / simulation plotting.
147-
- [x] Add Monitor / Source plotting
148-
- [x] Visualize symmetry in ``Simulation.plot``
149-
- [x] Add "plot" to all tidy3d objects.
150-
- [x] source time
151-
- [x] medium
152-
- [x] sampler
153-
- [x] Overlay structures onto fields.
154-
- [x] add .plot method to `SimulationData`
155-
---
156-
157158
#### "Tidying" Up
158159
- [x] clean up data.plot arguments. <- using xarray.
159160
- [x] Replace tqdm with rich
@@ -172,19 +173,18 @@
172173
- [ ] Move any interfaces in MonitorData to SimulationData (geometry, plotting, etc).
173174
- [ ] Remove unneeded data or monitor maps.
174175
- [ ] Make monitordata.load_from_data aware of lists
175-
- [ ] Use shapely for geometry ops / plotting? `Geometry.geo(x=0)` -> shapely representation.
176+
- [x] Use shapely for geometry ops / plotting? `Geometry.geo(x=0)` -> shapely representation.
176177
- [x] Fix all tests.
177178
- [x] Integrate shapely plotting / kwargs.
178179
- [x] Catch edge case where new shape intersects with **two** shapes of the same medium.
179180
- [x] Integrate overlapping shape plotting using intersection.
180181
- [x] Clean up arguments to polyslab.
181-
- [ ] Clean up pylint and org issues.
182+
- [x] Clean up pylint and org issues.
182183
- [x] use xmin, ymin, ... = `Geometry.intersections(axis).bounds` to ``get_bounds()``
183-
- [ ] Integrate shapely ops into bounds checking / intersection checking.
184+
- [x] Integrate shapely ops into bounds checking / intersection checking.
184185
- [x] Fix MyPy warnings. <- too many stupid ones? ..
185186
- [ ] Add Logging.
186187
- [ ] Migrate notebooks into static tests.
187-
- [ ] Interactive visualization?
188188
- [ ] Add PEC PMC.
189189
- [ ] Make Uniform Samplers separate classes? (dont evaluate / store freqs, times)?
190190
- [ ] setup.cfg for installing packages with more granularity (base, docs, tests)
@@ -239,7 +239,6 @@ https://github.com/crusaderky/python_project_template
239239
- [ ] Releases, PyPI setup (.5 days)
240240
- [ ] Wipe commit history
241241
- [ ] decide how to manage branches
242-
- [ ] Nice web api plotting / progressbars using `rich`
243242
---
244243

245244
#### Final
@@ -259,6 +258,8 @@ https://github.com/crusaderky/python_project_template
259258
- [ ] 3 panel lumerical style plot `Simulation.visualize()`
260259
- [ ] 3D structure plotting (matplotlib?)
261260
- [ ] Output Simulation as blender file
261+
- [ ] Interactive visualization.
262+
- [ ] html export plots.
262263
- [ ] Plugins
263264
- [ ] S matrix plugin
264265
- [ ] Optimizer plugin

0 commit comments

Comments
 (0)