emsig/emg3d

ToDo-list v1.0.0-rc.1 -> v1.0.0

prisae opened this issue · 1 comments

prisae commented

Another TODO-list; from the released emg3d v1.0.0-rc.2 to emg3d v1.0.0:

  • Documentation
    • About section (describe also logo)
    • Describe File Format
    • Describe Saving/Loading (in getting started)
    • Example using all source and receiver types (in getting started)
    • Improve development section (including solve-optimization; contributing)
    • Rename: user_guide->manual; api_reference->api, development->dev for shorter links
    • Show source code button
    • >>> vs In [1] (see, e.g., NumPy)
    • Add solve example/benchmark to dev-section
  • Testing
    • New version of discretize
    • Benchmarks
  • Gallery
    • Finish (8 missing)
    • Use pooch to fetch data; move data out to own repo.
    • Build automatically on GHA, store within emg3d, push artefacts to RTD (onto wishlist)
  • New logos / favicons (emg3d/empymod/EMSiG)
  • emsig.xyz
    • Sphinx
    • About section (describe also logo)
    • CNAME's (github.io and rtfd.io)
  • empymod
    • Update theme & README
    • About section (describe also logo)
    • v3.0 / coordinate system (?)
prisae commented

Ready for v1 - will treat empymod afterwards.