{{{#!comment
[[TracNav(doc/toc|nocollapse)]]
}}}
= PALM Model Documentation =
----
==   Model description ==
===   Model formulation
      * [wiki:doc/tec/gov Governing equations]
      * [wiki:doc/tec/sgs Turbulence closure]
      * [wiki:doc/tec/discret Discretization]
      * [wiki:doc/tec/pres Pressure solver]
      * [wiki:doc/tec/bc Boundary conditions]
      * [wiki:doc/tec/lsf Large-scale forcing]
      * [wiki:doc/tec/nudging Nudging]
      * [wiki:doc/tec/ocean Ocean option]
      * [wiki:doc/tec/coupled Coupled atmosphere-ocean simulations]
      * [wiki:doc/tec/nesting Nesting]

=== Embedded models
      * [wiki:doc/tec/1dmodel 1D model for precursor runs]
      * [wiki:doc/tec/canopy Canopy model]
      * [wiki:doc/tec/microphysics Bulk cloud model (BCM)]
      * [wiki:doc/tec/lcm Lagrangian cloud model (LCM)]
      * [wiki:doc/tec/lpm Lagrangian particle model (LPM)]
      * [wiki:doc/tec/lsm Land surface model]
      * [wiki:doc/tec/mas Multi Agent System]
      * [wiki:doc/tec/radiation Radiation models]
      * [wiki:doc/tec/wtm Wind turbine model]

=== Technical realization
      * [wiki:doc/tec/general General code structure]
      * [wiki:doc/tec/particle Particle code structure]
      * [wiki:doc/tec/topography Topography implementation]
      * [wiki:doc/tec/parallel Parallelization and optimization]
      * [wiki:doc/tec/user User interface] 
      * [wiki:doc/tec/modeloperation Model operation] 
      * [wiki:doc/tec/data Data handling]   
      * [wiki:doc/tec/doxygen Code documentation with Doxygen]
      * [wiki:doc/tec/naming_convention Rules of documentation and naming conventions]
      * [wiki:doc/tec/contributions Code contributions]

----
==   User manual

===  [wiki:doc/app/jobsteering  Steering of PALM runs with the PALM scripts]
      * [wiki:doc/app/jobcontrol     Running PALM with palmrun]
      * [wiki:doc/app/mrungui        Using the GUI: mrungui]
      * [wiki:doc/app/palm_wd        Monitoring batch jobs: PALM watchdog]
      * [wiki:doc/app/runs           Restart runs / Handling of large binary restart files]

===   Model steering
      * '''[wiki:doc/app/par Parameters]'''
         * [wiki:doc/app/inipar     Initialization]
         * [wiki:doc/app/d3par      Runtime]
         * [wiki:doc/app/nestpar    Nesting]
         * [wiki:doc/app/lsmpar     Land surface]
         * [wiki:doc/app/bcmpar     Bulk cloud physics]
         * [wiki:doc/app/oceanpar   Ocean mode]
         * [wiki:doc/app/nestofflpar Offline nesting]
         * [wiki:doc/app/canpar     Plant canopy]
         * [wiki:doc/app/parpar     Particles]
         * [wiki:doc/app/radpar     Radiation]
         * [wiki:doc/app/sppar      Spectra]
         * [wiki:doc/app/stg_par    Synthetic Turbulence]
         * [wiki:doc/app/flpar      Virtual flights]
         * [wiki:doc/app/wind_turbine_par     Wind turbine model]
         * [wiki:doc/app/dvrpar     dvr graphics]
         * [wiki:doc/app/parlist    Alphabetical list of all parameters]
      * '''[wiki:doc/app/userint    User Interface]'''
         * [wiki:doc/app/userint/int     Interfaces]
         * [wiki:doc/app/userpar         Parameters for user interface]
         * [wiki:doc/app/userint/userpar         Definition of user-defined parameters]
         * [wiki:doc/app/userint/subd    User-defined domains]
         * [wiki:doc/app/userint/output  User-defined output quantities]
         * [wiki:doc/app/userint/comp    Compiling and linking]
      * '''[wiki:doc/app/iofiles Input/Output files]'''
         * [wiki:doc/app/iofiles/pids    Palm input data standard]

===   [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
      * [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]