emsig / emg3d

A multigrid solver for 3D electromagnetic diffusion

Home Page:https://emg3d.emsig.xyz

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Roadmap to v1.0

prisae opened this issue · comments

Roadmap to a stable v1.0 release before 31/05/2021.

Plan:

  • RC1 mid-late March;
  • RC2 somewhen in April;
  • Release v1.0 early May.

Issues to address:

  • #166 Improve verbosity / logging
  • #132 Add magnetic receivers to Simulation (only one task of that PR)
  • #163 Improve documentation
    • Go through all docs
    • Create a tutorials gallery within the docs itself
    • Keep the existing gallery for heavier examples, comparisons, etc
    • Go through emsig.github.io: => emsig.xyz
    • Document coordinate system: Done
  • #129 Document file format
  • Gallery:
    • Add eh, he, lh, le comparison with empymod (l=loop)

Would be great to also include:

  • #172 Solver class
  • #173 Support arbitrarily shaped sources in Survey, Simulation; create Loop, Wire.

Other things to consider:

  • Double-check with +/- iw, also with respect to the loops
  • get_source_field and get_receiver_response should take a Dipole, Loop, or Wire.
  • Integration for subsurface. => will happen in discretize
  • Improve / generalize IO for lists and tuples.
  • Simulation.{to;from}_file()

Mostly done, RC will come tomorrow. Remaining things will be tracked in separate issues. Closing.