gyrokinetics / gs2 / 1821477209

!> Main GS2 program.  Essentially this parses the command

!> line and then, if we're not just requesting some information about

!> the build, proceeds to initialise a gs2_program_state_type object

!> with the mpi communicator, and then calls the standard sequence of

!> subroutines from gs2_main to run the program. See [[gs2_main]] for more

!> information.

!>

!> GS2 is an initial value nonlinear code which solves the gyrokinetic

!> equation. This is the source code documentation for GS2, and is

!> aimed at developers.

!>

!> User Documentation For a general introduction and user

!> documentation please go to

!> https://gyrokinetics.gitlab.io/gs2/index.html

!>

!> A useful starting point is https://gyrokinetics.gitlab.io/gs2/index.html

!>

!> To build the documenation locally you will need the `ford` python

!> package and you should then be able to run `make doc`. Open

!> `docs/html/index.html` to access.

  use gs2_main, only : run_gs2, gs2_program_state_type, parse_command_line

  use gs2_optimisation, only: run_optimise_gs2

  implicit none