Roadmap to `v0.1`

[maltezfaria]

Things to polish/finish prior to release:

Usage

• Streamline how boundary conditions are passed to the LevelSetEquation constructor. Example that should work: Improve implementation of boundary conditions #35

bc = (PeriodicBC(), (NeumannBC(), DirichletBC()))
bc = PeriodicBC()
bc = NeumannBC()

Example that should error:

bc = ((PeriodicBC(), DirichletBC), ...) # error

• Decide on what a boundary condition means when indices are out of bounds in more than one dimension Improve implementation of boundary conditions #35

Documentation

• General section on package usage, overview, etc @maltezfaria Improve docs in preparation for registration #36
• A section on LevelSetTerm
  • Pour la courbure on peux se servir de la spirale Add small curvature test with a spiral #37
  • Advection term (done in Docs for advection term #38)
• Time integrators (done in Document time stepping #39)
• Boundary conditions
• Extensions
  • Makie
  • MMG Add small curvature test with a spiral #37
• Examples
  • Zalesak circle (WENO vs. upwind)
  • Shape optimisation Add small curvature test with a spiral #37
  • Maybe Eikonal solver using reinitialisation (v0.2.0)
  • Shape optimisation using integral equations for Laplace problem (v0.2.0)

Polish

• Remove dead code using Codecov once docs are written and coverage is setup to track docs (v0.2.0)
• Clean export
• Modify Makie recipe to use contourf to distinguish inside/outiside
• Write the _normalize_bc function Improve implementation of boundary conditions #35

Features

• Utility to compute volume and perimeter of LevelSet Add small curvature test with a spiral #37

[maltezfaria]

Registration PR can be found here:

JuliaRegistries/General#119346