Improved Documentation

[FelixTheilen]

This pull request has been redesigned to specifically adress issue https://github.com/desy-ml/cheetah/issues/2 . -The pull request introduces a new comment on the 'init' function. This will help finding the definitions for the parameters. -Also a new comment on the 'transfer_map' function has been added, explaining the general purpose as well as the state vector and parameters, returns and raises. -The parameter 'energy' has been removed from various classes. The parameter 'energy' is passed on through the beam passed to the segment. It is therefore not changeable by the user, when trying to control the beam, e.g. you can't call the function HorizontalCorrector and pass a parameter energy to this function. This parameter is defined, when the beam is fed in the Segment. -'repr' has now a short comment describing the use of this function. -Spelling mistakes have been corrected in accelerator.py and particles.py.

[cr-xu]

Hi, I marked the PR as draft. Once all changes are made and pushed, you can mark it as ready and ask for review/merge.

[jank324]

@FelixTheilen I think it makes sense to split this pull request into three:

• Extension of and spelling fixes for the documentation (addressing issue #2)
• Fix for BPM bug (addressing issue #20)
• Fix for uninformative warning about ParameterBeam not being on the same device as a Segment when a GPU is available (addressing issue #19)

[FelixTheilen]

This pull request has been redesigned to specifically adress issue #2 . -The pull request introduces a new comment on the 'init' function. This will help finding the definitions for the parameters. -Also a new comment on the 'transfer_map' function has been added, explaining the general purpose as well as the state vector and parameters, returns and raises. -The parameter 'energy' has been removed from various classes. The parameter 'energy' is passed on through the beam passed to the segment. It is therefore not changeable by the user, when trying to control the beam, e.g. you can't call the function HorizontalCorrector and pass a parameter energy to this function. This parameter is defined, when the beam is fed in the Segment. -'repr' has now a short comment describing the use of this function. -Spelling mistakes have been corrected in accelerator.py and particles.py.

[FelixTheilen]

I reused the branch needed for the improvement of the documentation. This resulted in this pull request not changing anything in the desy-ml/master file. Unfortunately this couldnt be reverted, as i had the previous file, but i could'nt update since Github thought the removal of items made the master branch more up to date.