search

JuliaFusion / OWCF

A framework for Synthetic Diagnostics using Energetic-particle Orbits in Tokamaks
Apache License 2.0
8 stars 0 forks source link

Documentation issues #1

Open henrikjaerleblad opened 1 year ago

henrikjaerleblad commented 1 year ago

This issues thread will be used to keep track of erronous documentation that needs amending, as well as documentation that does not yet exist but needs to be written.

When a particular documentation issue has been fixed, the pertaining comment will be deleted.

henrikjaerleblad commented 1 year ago

The PDF documentation for the extra/compSolovev.jl script needs to be updated

henrikjaerleblad commented 1 year ago

The in-script function descriptions for the os2COM() collection of functions in extra/dependencies.jl need to be updated to reflect the fact that they can now be used to transform distributions from (E,pm,Rm) to (E,mu,Pphi;sigma). They use automatic differentiation to compute the Jacobi matrix from (E,pm,Rm) to (E,mu,Pphi;sigma)

henrikjaerleblad commented 1 year ago

The PDF documentation for the apps/orbitWebApp.jl web application needs to be updated to include the option of displaying an animation of the fast-ion orbit

henrikjaerleblad commented 1 year ago

Due to the need for the Julia version to be at v1.8, or below, for the orbit-integrating functions to work (in GuidingCenterOrbits.jl), the formulation in the PDF documentation 'howToInstall...pdf' needs to be changed from 'The newer the better' to 'A maximum of Julia v1.8 needs to be ensured'

JoseRuedaRueda commented 4 months ago

The PDF needs to be slightly modified, instead of uncompressing a zip, the PDF should recommend users to clone the code via git, which is always better for version control that a random zip image

JoseRuedaRueda commented 4 months ago

Mac docs makes reference to windows installation image