beam-tracing / Scotty

Beam tracing code for diagnostics
https://scotty.readthedocs.io/en/latest/
GNU General Public License v3.0
7 stars 4 forks source link

Added some documentation #83

Closed valerian-chen closed 1 year ago

valerian-chen commented 1 year ago

Hey @ZedThree, I'm afraid I can't get the bulleted list in 'output parameters' to work. What am I doing wrong?

ZedThree commented 1 year ago

Ah, you're missing a blank line before the start:

Saved in data_input

* launch_K - initial wavevector
* launch_position - initial position
* mode_flag - polarisation
See `beam_me_up` for a detailed description of input parameters.

Saved in data_output

* q_R_array - beam trajectory, R coordinate
* q_zeta_array - beam trajectory, zeta coordinate
* q_Z_array - beam trajectory, Z coordinate

Saved in analysis_output

* Psi_xx_output - xx component of Psi_w
* Psi_xy_output - xy component of Psi_w
* Psi_yy_output - yy component of Psi_w

That should work