Skip to content

Commit f11c789

Browse files
committed
updated readme, some small improvements, ready for git flow
1 parent de7dcca commit f11c789

File tree

12 files changed

+2545
-563
lines changed

12 files changed

+2545
-563
lines changed

README.md

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -140,11 +140,17 @@
140140
---
141141

142142
#### Web Integration (requires solver integration)
143-
- [ ] refactor webapi using conversion.
144-
- [ ] add http / authentication etc.
145-
- [ ] Nice web api plotting / progressbars using `rich`.
146-
- [ ] Set up so that daemon recgonizes new json files.
147-
- [ ] Test test test.
143+
- [ ] Get webAPI working with conversion
144+
- [ ] refactor webapi internals.
145+
- [ ] add http / authentication etc.
146+
- [ ] hook webapi to conversion.
147+
- [ ] Test with simple run.
148+
- [ ] Add some example notebooks using supported sources / monitors.
149+
- [ ] Include Nice web api plotting / progressbars using `rich`.
150+
- [ ] Get webAPI working without conversion.
151+
- [ ] Use native `Simulation.export()` or `Simulation.json()` for ``upload()`.
152+
- [ ] Use native `SimulationData.load()` for `load()`.
153+
- [ ] Test test test and then test more.
148154
---
149155

150156
#### Finishing Integration
@@ -186,10 +192,33 @@
186192
- [ ] Add Logging.
187193
- [ ] Migrate notebooks into static tests.
188194
- [ ] Add PEC PMC.
195+
- [ ] Handle Inf as it's own keyword that depends on simulation bounds.
189196
- [ ] Make Uniform Samplers separate classes? (dont evaluate / store freqs, times)?
190197
- [ ] setup.cfg for installing packages with more granularity (base, docs, tests)
191198
---
192199

200+
#### Momchil's To Do Notes
201+
- [ ] Front end
202+
- [ ] More discussion in Simulation docs.
203+
- [ ] Courant 0.99 stable? Adjust range of acceptable values.
204+
- [ ] Support nonuniform coordinates.
205+
- [ ] Support Medium names eventually.
206+
- [ ] Support diagonal anisotropy.
207+
- [ ] GDS slab import (+shapely import).
208+
- [ ] If using "polarization" kwarg, specify 'J' or 'E' in source?.
209+
- [ ] Conversion
210+
- [ ] Find proper way to link tidy3d and tidy3d core. (core imports local copy of Simulation always updated and on main branch by default?).
211+
- [ ] Convert dispersive models to PoleResidue.
212+
- [ ] Support plane wave, gaussian beam, modesource in JSON conversion.
213+
- [ ] Support mode monitor, permittivity monitor in JSON conversion.
214+
- [ ] Data
215+
- [ ] Provide optional args to only export the `MonitorData` of selected `Monitor`s.
216+
- [ ] Wrap string conversion in MonitorLoad in helper function.
217+
- [ ] Assert SimulationData's monitor names exist in original Simulation.
218+
- [ ] Solver field data evaluated at yee cell locations, sufficient to interpolate values anywhere in monitor volume.
219+
- [ ] Eliminate need for storing `monitor_name` in `MonitorData`.
220+
---
221+
193222
### Stage 3: Refining
194223

195224
A good template:
@@ -199,6 +228,7 @@ https://github.com/crusaderky/python_project_template
199228

200229
- [ ] Finalize writing of internal documentation (1 week)
201230
- [ ] Add and edit docstrings to all.
231+
- [ ] Add example code snippets to everything.
202232
- [ ] Set up documentation (1 week)
203233
- [x] Make pydantic autosummaries more pretty.
204234
- [ ] Move Docs into repo.
@@ -207,9 +237,11 @@ https://github.com/crusaderky/python_project_template
207237
- [x] Loading data.
208238
- [x] Visualizing data.
209239
- [ ] Batch simulation.
210-
- [ ] How to include material library explanation?
240+
- [ ] Include material library.
241+
- [ ] make docs pretty,
211242
- [ ] Move tidy3d notebooks into repo, make them work with new code.
212-
- [ ] test binder links.
243+
- [ ] set up and test binder links.
244+
- [ ] Separate notebooks / docs into its own repo?
213245
---
214246

215247
#### Testing
@@ -218,7 +250,7 @@ https://github.com/crusaderky/python_project_template
218250
- [x] Test simulation.json validation / error catching.
219251
- [x] Test plugins.
220252
- [x] Test notebooks.
221-
- [ ] Test submitting jobs if possible.
253+
- [ ] Test submitting jobs if possible <- do this on tidy3dcore tests?
222254
- [ ] Import and integrate tests from existing solvers.
223255
---
224256

@@ -243,6 +275,7 @@ https://github.com/crusaderky/python_project_template
243275

244276
#### Final
245277
- [ ] Finding bugs and fixing things, testing (2 weeks)
278+
- [ ] White paper on arxiv?
246279
- [ ] Release publicly! :partying_face:
247280
---
248281

explore/Inf.ipynb

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

0 commit comments

Comments
 (0)