meep plugin and docs improvements

[joamatab]

• better docstrings with autodoc_typehints = "description"
• improve meep plugin.
  • remove port_field_monitor_name parameter (no longer needed) thanks to meep 1.23 introduced to use the energy in the whole simulation to determine when to terminate, which is a better termination condition than the energy at the ports. PR. Requires meep 1.23 or newer.
  • update termination condition for grating_coupler simulations.
  • rename effective permitivity to get_effective index. Change units from meters to um, and permitivities to refractive_index to be consistent with gdsfactory units in um.
• add gf.generate_doe PR
• add add_center_section to CrossSection and cross_section for slot cross_section PR fixes

[sourcery-ai]

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.46%.

Quality metrics	Before	After	Change
Complexity	14.01 🙂	13.83 🙂	-0.18 👍
Method Length	155.53 😞	170.41 😞	14.88 👎
Working memory	20.98 ⛔	21.26 ⛔	0.28 👎
Quality	40.16% 😞	39.70% 😞	-0.46% 👎

Other metrics	Before	After	Change
Lines	3180	3047	-133

Changed files	Quality Before	Quality After	Quality Change
docs/conf.py	77.62% ⭐	77.30% ⭐	-0.32% 👎
gdsfactory/simulation/gmeep/get_material.py	72.23% 🙂	72.23% 🙂	0.00%
gdsfactory/simulation/gmeep/get_simulation.py	19.79% ⛔	22.20% ⛔	2.41% 👍
gdsfactory/simulation/gmeep/get_simulation_grating_fiber.py	39.55% 😞	39.55% 😞	0.00%
gdsfactory/simulation/gmeep/test_eigenmode.py	47.97% 😞	47.97% 😞	0.00%
gdsfactory/simulation/gmeep/test_write_sparameters_meep.py	72.34% 🙂	72.34% 🙂	0.00%
gdsfactory/simulation/gmeep/write_sparameters_grating.py	42.83% 😞	42.86% 😞	0.03% 👍
gdsfactory/simulation/gmeep/write_sparameters_meep.py	21.87% ⛔	21.87% ⛔	0.00%
gdsfactory/simulation/gmeep/write_sparameters_meep_batch.py	32.03% 😞	32.03% 😞	0.00%
gdsfactory/simulation/gmeep/write_sparameters_meep_mpi.py	35.32% 😞	35.32% 😞	0.00%

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
gdsfactory/simulation/gmeep/write_sparameters_meep.py	write_sparameters_meep	51 ⛔	942 ⛔	37 ⛔	3.28% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
gdsfactory/simulation/gmeep/get_simulation.py	get_simulation	23 😞	657 ⛔	40 ⛔	13.68% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
gdsfactory/simulation/gmeep/write_sparameters_meep_batch.py	write_sparameters_meep_batch	23 😞	322 ⛔	15 😞	24.74% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
gdsfactory/simulation/gmeep/write_sparameters_meep_mpi.py	write_sparameters_meep_mpi	14 🙂	341 ⛔	18 ⛔	28.00% 😞	Try splitting into smaller methods. Extract out complex expressions
gdsfactory/simulation/gmeep/get_simulation_grating_fiber.py	get_simulation_grating_fiber	5 ⭐	990 ⛔	53 ⛔	28.40% 😞	Try splitting into smaller methods. Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication