JuliaPhysics/SolidStateDetectors.jl

Write documentation for v0.6 release

fhagemann opened this issue · 0 comments

Find a list of things that need to be written/updated for the v0.6 documentation:

  • How to define a ChargeDriftModel
  • More information on the ADLChargeDriftModel (#144)
  • How to define an ImpurityDensityModel (#140)
  • How to create/structure config files (#136), especially concerning rotations (#62), crystal orientation (#161), and other stuff that got added
  • How to split config files (#104)
  • How to plot potentials and fields (ElectricPotential, ElectricField + lines, ...)
  • Docstrings for exported functions
  • Add a reference to the SSD publication (arXiv or JINST publication) to README.md (?)
    --> #175

Feel free to complete this list.