Fix Animate2D

[thomasdorch]

Closes #2261
Fixes and improvements to Animate2D:

• Fix ordering of fields and sim arguments to Animate2D
• Fix issue where fields were not updating in Animate2D
• Added more type hints
• Removed sim argument in Animate2D from all tutorials

[codecov-commenter]

Codecov Report

Merging #2264 (c8ee1ae) into master (9ac05a0) will decrease coverage by 0.00%.
The diff coverage is 53.12%.

@@            Coverage Diff             @@
##           master    #2264      +/-   ##
==========================================
- Coverage   73.23%   73.22%   -0.01%     
==========================================
  Files          17       17              
  Lines        4916     4922       +6     
==========================================
+ Hits         3600     3604       +4     
- Misses       1316     1318       +2     

Impacted Files	Coverage Δ
python/visualization.py	41.45% <53.12%> (-0.05%)	⬇️
python/adjoint/optimization_problem.py	57.94% <0.00%> (+0.65%)	⬆️

[stevengj]

I'm not sure what adding plot_eps has to do with this? Should it be called plot_eps or plot2D(fields=mp.Dielectric)?

[thomasdorch]

@stevengj I added it in just for consistency so that the code blocks for plotting epsilon and plotting fields look more similar:

if self.update_epsilon:
    ...
    eps = sim.plot_eps(**filtered_plot_eps)
    ...
if self.fields is not None:
    ...
    fields = sim.plot_fields(fields=self.fields, **filtered_plot_fields)
    ...

instead of:

if self.update_epsilon:
    ...
    eps = plot_eps(sim, **filtered_plot_eps)
    ...
if self.fields is not None:
    ...
    fields = sim.plot_fields(fields=self.fields, **filtered_plot_fields)
    ...

Good point about plot2D, it might make sense to use it for both actually. The issue with this would be that the plot_eps and plot_fields aren't actually plotting since no ax is passed to them. I think I should drop that commit from this PR and potentially make another PR to refactor a bit of the visualization code and clean this part up. What do you think?

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[oskooi]

The Python test suite is failing the Python 3.7 build configuration because of the missing Literal type in the typing module which was only introduced in Python 3.8 with PEP 586.

FAIL: tests/test_3rd_harm_1d
============================

Traceback (most recent call last):
  File "../../../python/tests/test_3rd_harm_1d.py", line 5, in <module>
    import meep as mp
  File "/home/runner/work/meep/meep/build/meep-1.25.0-beta/_build/sub/python/meep/__init__.py", line 4440, in <mo\
dule>
    from .visualization import (
  File "/home/runner/work/meep/meep/build/meep-1.25.0-beta/_build/sub/python/meep/visualization.py", line 17, in \
<module>
    from typing import Callable, Union, Any, Literal, Tuple, List
ImportError: cannot import name 'Literal' from 'typing' (/opt/hostedtoolcache/Python/3.7.14/x64/lib/python3.7/typ\
ing.py)

[thomasdorch]

Thanks for pointing that out @oskooi. I dropped the Literal type annotation from the commit.

[oskooi]

LGTM.