search

desy-ml / cheetah

Fast and differentiable particle accelerator optics simulation for reinforcement learning and optimisation applications.
https://cheetah-accelerator.readthedocs.io
GNU General Public License v3.0
30 stars 13 forks source link

Improved documentation #2

Closed jank324 closed 2 months ago

jank324 commented 1 year ago

📚 Documentation

The documentation needs some cleanup and extension. In particular, we should make sure that the API reference is clear and that there is a get-started guide.

Motivation

The repo is now public and it should be easy for other people to use Cheetah.

jank324 commented 1 year ago

We also need to make the readthedocs page working along with improving the documentation.

jank324 commented 1 year ago

The page on readthedocs is now functional. What is missing is some more documentation to that page, including auto-generated documentation for all the functions and classes.

jank324 commented 2 months ago

Actually, the documentation is reasonably good now. So I'm closing this.