= PALM Technical Documentation =
...short description...

{{{#!table align=center style="border: none; text-align:left"
   {{{#!tr
      {{{#!td align=left style="border: none; vertical-align:top; width: 35%"
         [[Image(palmpage_icons_wotitle_doc.png, 100%)]]
      }}}
      {{{#!td style="border: none;vertical-align:top; width:20%"
\\'''PALM core'''\\\\
[wiki:doc/tec/gov     Governing equations atmosphere]\\\\
[wiki:doc/tec/ocean   Governing equations ocean]\\\\
[wiki:doc/tec/pres    Pressure solver]\\\\
[wiki:doc/tec/sgs     Turbulence closure]\\\\
[wiki:doc/tec/discret Discretization]\\\\
[wiki:doc/tec/bc      Boundary conditions]\\\\
[wiki:doc/tec/initialization Initialization]\\\\
{{{#!comment
[wiki:doc/tec/1dmodel 1D model for precursor runs]
}}}
      }}}
      {{{#!td style="border: none;vertical-align:top; width:20%"
\\'''Additional features'''\\\\
[wiki:doc/tec/coupled      Atmosphere-ocean coupling]\\\\
[wiki:doc/tec/microphysics Cloud microphysics]\\\\
[wiki:doc/tec/nesting      Grid nesting]\\\\
[wiki:doc/tec/lcm          Lagrangian cloud model (LCM)]\\\\
[wiki:doc/tec/lpm          Lagrangian particle model (LPM)]\\\\
[wiki:doc/tec/lsm          Land surface model (LSM)]\\\\
[wiki:doc/tec/lsf          Large-scale forcing]\\\\
[wiki:doc/tec/nudging      Nudging]\\\\
[wiki:doc/tec/canopy       Plant canopy model (PCM)]\\\\
[wiki:doc/tec/radiation    Radiation models]\\\\
[wiki:doc/tec/wtm          Wind turbine model (WTM)]\\\\
      }}}
      {{{#!td style="border: none;vertical-align:top; width:20%"
\\'''Technical aspects'''\\\\
[wiki:doc/tec/doxygen Code documentation with Doxygen]\\\\
[wiki:doc/tec/data Data handling]\\\\
[wiki:doc/tec/general General code structure]\\\\
[wiki:doc/app/machine Machine-related information]\\\\
{{{#!comment
FEED TO app/machine PAGE
      * [wiki:doc/app/machine/kisti   IBM-Regatta (KISTI)]
      * [wiki:doc/app/machine/hlrnIII Cray-XC40 (HLRN)]
      * [wiki:doc/app/machine/kyushu_univ Kyushu University Computing Center]
}}}
[wiki:doc/tec/parallel Parallelization and optimization]\\\\
[wiki:doc/tec/particle Particle code structure]\\\\
[wiki:doc/tec/preproc Pre-processor directives]\\\\
[wiki:doc/tec/topography Topography implementation]\\\\
[wiki:doc/tec/user User-code implementation]\\\\
{{{#!comment
MOVE SOMEWHERE ELSE
      * [wiki:doc/tec/contributions Code contributions]
      * [wiki:doc/tec/naming_convention Rules of documentation and naming conventions]
}}}
      }}}
   }}}
}}}

= PALM Program Control =
...short description...

{{{#!table align=center style="border: none; text-align:left"
   {{{#!tr
      {{{#!td align=left style="border: none; vertical-align:top; width: 35%"
         [[Image(palmpage_icons_wotitle_pc.png, 100%)]]
      }}}
      {{{#!td style="border: none;vertical-align:top; width:20%"
'''Model operation'''\\\\
[wiki:doc/tec/modeloperation Overview]\\\\
__Launching a simulation__\\
[wiki:doc/app/jobcontrol     mrun]\\
[wiki:doc/app/mrungui        mrungui]\\
[wiki:doc/app/configexample  Model setup example]\\
[wiki:doc/app/intdbg         Interactive mode and debugging]\\
[wiki:doc/app/runs           Simulation chains]\\
[wiki:doc/app/runs           (Restarts & large-file handling)]\\\\
__Monitoring a simulation__\\
[wiki:doc/app/palm_wd        PALM watchdog (batch jobs)]\\
      }}}
      {{{#!td style="border: none;vertical-align:top; width:20%"
'''Model setup'''\\\\
[wiki:doc/app/par Overview]\\\\
__PALM core parameters__\\
[wiki:doc/app/inipar     Initialization]\\
[wiki:doc/app/d3par      Runtime]\\\\
__PALM feature parameters__\\
[wiki:doc/app/dvrpar               dvr graphics output]\\
[wiki:doc/app/parpar               Lagrangian particle model]\\
[wiki:doc/app/lsmpar               Land surface model]\\
[wiki:doc/app/nestpar              Nesting]\\
[wiki:doc/app/canpar               Plant canopy model]\\
[wiki:doc/app/radpar               Radiation model]\\
[wiki:doc/app/sppar                Spectra output]\\
[wiki:doc/app/stg_par              Synthetic Turbulence]\\
[wiki:doc/app/userpar              User defined]\\
[wiki:doc/app/flpar                Virtual flight model]\\
[wiki:doc/app/wind_turbine_par     Wind turbine model]\\\\
[wiki:doc/app/parlist              Alphabetical list]
      }}}
      {{{#!td style="border: none;vertical-align:top; width:20%"
'''Code extensions'''\\\\
[wiki:doc/app/userint/int     Interfaces to PALM core]\\\\
[wiki:doc/app/userint/comp    Compiling and linking]\\\\
[wiki:doc/app/userint/output  User-defined data output]\\\\
[wiki:doc/app/userint/subd    User-defined domains]\\\\
[wiki:doc/app/userpar         User-defined parameters]\\\\
      }}}
   }}}
}}}
\\\\



LEFT OVER
* Debugging ---> move where???



 




= PALM Data I/O and visualization =
(to be resorted!!)
* '''[wiki:doc/app/iofiles Input/Output files]'''

* '''[wiki:doc/app/netcdf  netCDF data output]'''
   * [wiki:doc/app/ncgen Generation of a PALM netCDF file]
   * [wiki:doc/app/ncexample Example of a PALM netCDF data set]
   * [wiki:doc/app/maskedoutput Masked data output]
* '''[wiki:doc/app/ncl  Postprocessing with NCL]'''
   * [wiki:doc/app/nclparlist  List of parameters for PALM NCL scripts]
* [wiki:doc/app/idl Postprocessing with IDL]
* [wiki:doc/app/dvr Visualization with dvr]
* [wiki:doc/app/vapor Visualization with VAPOR]
* [wiki:doc/app/img2video Creating animations with img2video]
* [wiki:doc/app/img2stereo Creating stereo images with img2stereo]




      * '''[wiki:doc/app/iofiles Input/Output files]'''
         * [wiki:doc/app/iofiles/pids    Palm input data standard]



= [wiki:doc/app/examples Simulation examples] =
!!!needs special care!!!
      * [wiki:doc/app/examples/cbl      Minimum set for simulating the CBL]
      * [wiki:doc/app/examples/topo     Topography]
      * [wiki:doc/app/examples/turbinf  Turbulent inflow]
      * [wiki:doc/app/examples/ocean    Ocean runs]
      * [wiki:doc/app/examples/coupled  Coupled atmosphere-ocean runs]
      * [wiki:doc/app/examples/lsf  Runs with large scale forcing and nudging]
      * [wiki:doc/app/examples/rrtmg  Run with land surface model and coupled to the RRTMG radiation model]




{{{#!comment
[[TracNav(doc/toc|nocollapse)]]
}}}
= PALM Model Documentation =
----
==   Model description ==
===   Model formulation
...

=== Embedded models
...

=== Technical realization
...

----
==   User manual

===  [wiki:doc/app/jobsteering  Steering of interactive / batch runs]
...

===   Model steering
...

===   [wiki:doc/app/examples Steering examples for special setups]
      * [wiki:doc/app/examples/cbl      Minimum set for simulating the CBL]
      * [wiki:doc/app/examples/topo     Topography]
      * [wiki:doc/app/examples/turbinf  Turbulent inflow]
      * [wiki:doc/app/examples/ocean    Ocean runs]
      * [wiki:doc/app/examples/coupled  Coupled atmosphere-ocean runs]
      * [wiki:doc/app/examples/lsf  Runs with large scale forcing and nudging]
      * [wiki:doc/app/examples/rrtmg  Run with land surface model and coupled to the RRTMG radiation model]

===   Data handling/visualization
      * '''[wiki:doc/app/netcdf  netCDF data output]'''
         * [wiki:doc/app/ncgen Generation of a PALM netCDF file]
         * [wiki:doc/app/ncexample Example of a PALM netCDF data set]
         * [wiki:doc/app/maskedoutput Masked data output]
      * '''[wiki:doc/app/ncl  Postprocessing with NCL]'''
         * [wiki:doc/app/nclparlist  List of parameters for PALM NCL scripts]
      * [wiki:doc/app/idl Postprocessing with IDL]
      * [wiki:doc/app/dvr Visualization with dvr]
      * [wiki:doc/app/vapor Visualization with VAPOR]
      * [wiki:doc/app/img2video Creating animations with img2video]
      * [wiki:doc/app/img2stereo Creating stereo images with img2stereo]

===   [wiki:doc/app/errmsg  Error messages]
      * [wiki:doc/app/errmsg#PA0001 PALM standard code (PA****)]
      * [wiki:doc/app/errmsg#UI0001 User interface (UI****)]
      * [wiki:doc/app/errmsg#NC NetCDF (NC****)]
----

==   PALM code development
      * [wiki:doc/tec/releasenotes Release notes]
      * [wiki:doc/tec/changelog History of changes (2018-current)]
      * [wiki:doc/tec/changelog_2017 History of changes (2017)]
      * [wiki:doc/tec/changelog_2013-2016 History of changes (2013-2016)]
      * [wiki:doc/tec/changelog_2009-2012 History of changes (2009-2012)]
      * [wiki:doc/tec/developerrules Rules for developers]
      * [wiki:doc/tec/palm4udev PALM-4U development]
      * [wiki:doc/tec/eclipse Code development with eclipse]
      * [wiki:doc/tec/bugs Known bugs]
      * [wiki:doc/tec/testsuite Testsuite and Testserver]
      * [wiki:doc/tec/gpu OpenACC tests]

----

==   Machine related informations
...