Changes between Initial Version and Version 1 of doc/tec

Timestamp:

Nov 19, 2018 1:27:08 PM (6 years ago)

Author:

scharf

Comment:

--

doc/tec

@@ +1 @@
+= PALM Technical Documentation =
+
+{{{#!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]\\\\
+      }}}
+      {{{#!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]\\\\
+[wiki:doc/tec/parallel Parallelization and optimization]\\\\
+[wiki:doc/tec/particle Particle code structure]\\\\
+[wiki:doc/tec/topography Topography implementation]\\\\
+[wiki:doc/tec/user User-code implementation]\\\\
+      }}}
+   }}}
+}}}
+
+= PALM Program Control =
+
+{{{#!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)]\\\\
+__Debugging a simulation__\\
+[wiki:doc/tut/palm#Lecturepresentations Debugging options]\\
+[wiki:doc/app/errmsg                    Error messages]\\\\
+__Simulation I/O__\\
+[wiki:doc/app/iofiles        Input/Output files]\\
+[wiki:doc/app/iofiles/pids   Palm input data standard]
+      }}}
+      {{{#!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         Overview]\\\\
+[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]\\\\
+      }}}
+   }}}
+}}}
+
+= PALM Data I/O and Visualization =
+
+{{{#!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_io.png, 100%)]]
+      }}}
+      {{{#!td style="border: none;vertical-align:top; width:20%"
+\\'''PALM I/O files'''\\\\
+[wiki:doc/app/iofiles        Input/Output files]\\\\
+[wiki:doc/app/iofiles/pids   Palm input data standard]\\\\
+      }}}
+      {{{#!td style="border: none;vertical-align:top; width:20%"
+\\'''NetCDF data output'''\\\\
+[wiki:doc/app/netcdf       Overview]\\\\\\
+[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]\\\\
+      }}}
+      {{{#!td style="border: none;vertical-align:top; width:20%"
+\\'''Visualization'''\\\\
+[wiki:doc/app/ncl        Plotting with palmplot (NCL)]\\\\
+[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]\\\\
+      }}}
+   }}}
+}}}
+
+
+= PALM Tutorial =
+
+{{{#!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_tut.png, 100%)]]
+      }}}
+      {{{#!td style="border: none;vertical-align:top; width:20%"
+\\'''Theory, numerics, technical information'''\\\\
+[wiki:doc/tut/palm#Lecturepresentations Lecture presentations of PALM seminar 2017]\\\\
+      }}}
+      {{{#!td style="border: none;vertical-align:top; width:20%"
+\\'''Simple simulation examples'''\\\\\\
+[wiki:doc/tut/palm#Exercisepresentations Exercises of PALM seminar 2017]\\\\
+__Topics__\\\\
+Convective boundary layer\\\\
+Neutral boundary layer\\\\
+Flow around building\\\\
+Land surface model\\\\
+Lagrangian & Eulerian dispersion modeling\\\\
+      }}}
+      {{{#!td style="border: none;vertical-align:top; width:20%"
+\\'''Advanced simulation examples'''\\\\\\
+[wiki:doc/app/examples Overview]\\\\\\
+[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]\\\\
+      }}}
+   }}}
+}}}
+
+
+
+
+
+
+----
+
+==   Where to? ==
+
+* [wiki:doc/tec/changelog History of changes (2018-current)]
+* [wiki:doc/tec/contributions Code contributions] ----> move to "About us" (MUST be updated before)
+* [wiki:doc/tec/preproc Pre-processor directives] ----> should be mentioned somewhere in palmrun docu
+* [wiki:doc/app/jobsteering  Steering of interactive / batch runs!!] ----> add to Model operation overview
+
+
+
+== Developers area ==
+* [wiki:doc/tec/developerrules Rules for developers]
+* [wiki:doc/tec/naming_convention Rules of documentation and naming conventions]
+* [wiki:doc/tec/palm4udev PALM-4U development]
+* [wiki:doc/tec/eclipse Code development with eclipse]
+* [wiki:doc/tec/bugs Known bugs] --> What matters for standard users should be added to parameter descriptions!!
+* [wiki:doc/tec/testsuite Testsuite and Testserver]
+* [wiki:doc/tec/gpu OpenACC tests]
+
+
+
+
+