Changes between Version 21 and Version 22 of doc/app/palmrun_quickstart

Timestamp:

Nov 23, 2018 9:43:07 AM (6 years ago)

Author:

kanani

Comment:

--

doc/app/palmrun_quickstart

@@ -1 +1 @@
 = PALM Quickstart Guide =
 
-Ideally, you have successfully installed PALM using the [wiki:doc/install/automatic automatic installer].\\ If so, the installer has 
-* downloaded PALM from the subversion control (svn) repository into a predefined directory structure on your local PC (see Fig. 1),
-* created the required palmrun [wiki:doc/app/palmrun configuration file], e.g. '''.palm.config.default''' (hidden file),
-* pre-compiled ([wiki:doc/app/palmbuild palmbuild]) the '''UTIL'''ity programs and '''SOURCE''' code,
+Ideally, you have successfully installed PALM using the [wiki:doc/install/automatic automatic installer]. If so, the installer has 
+* downloaded PALM from the subversion control (svn) repository into a predefined directory structure on your local computer (see Fig. 1),\\\\
+* created the required palmrun [wiki:doc/app/palmrun configuration file], e.g. '''.palm.config.default''' (hidden file),\\\\
+* written some environment variables to Bash configuration file {{{$HOME/.bashrc}}}
+{{{
+  export PATH=$HOME/palm/current_version/trunk/SCRIPTS:$PATH
+  export PALM_BIN=$HOME/palm/current_version/trunk/SCRIPTS
+}}}
+* pre-compiled ([wiki:doc/app/palmbuild palmbuild]) the '''UTIL'''ity programs and '''SOURCE''' code,\\\\
 * run some small test simulations ('''JOBS''', see Fig. 2).\\
 
-{{{
-#!div style="align:'left'; width: 270px; border: 0px solid; float:left"
-[[Image(file_tree_1.png, 250px, right, margin-right=2, margin-top=0, border=0)]]\\
-'''Fig. 1''' Directory structure of PALM installation.
-}}}
-{{{
-#!div style="align:'left'; width: 270px; border: 0px solid; float:left"
-[[Image(file_tree_2.png, 250px, right, margin-right=2, margin-top=0, border=0)]]\\
-'''Fig. 2''' Directory structure of a simulation.
+
+{{{#!table style="border: none"
+   {{{#!tr
+      {{{#!td  style="border: none; width:10%" \\
+      }}}
+      {{{#!td style="border: none;vertical-align:top"
+'''Fig. 1'''\\\\
+[[Image(file_tree_1.png, 50%, left)]]
+      }}}
+      {{{#!td  style="border: none; width:0%" \\
+      }}}
+      {{{#!td style="border: none;vertical-align:top"
+'''Fig. 2'''\\\\
+[[Image(file_tree_2.png, 50%, left)]]\\\\
+      }}}
+   }}}
 }}}
 
-\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
+\\
 Somewhere near the end of the automatic installation process, the following lines should have appeared in your terminal:\\
 {{{
@@ -25 +37 @@
 PALM installer finished.
 }}}
+
 \\
 Further, the installer has printed an example command for starting a PALM simulation, e.g.
@@ -38 +51 @@
 }}}
 
-
-We have a [wiki:doc/app/palmrungui GUI] to create and submit the palmrun command (software requirements: QT4, python). Type into the terminal:
+We have a [wiki:doc/app/palmrungui GUI] to create and submit the palmrun command (software requirements: QT4, python). Typing:
 {{{
 palmrungui
 }}}
-
+into the terminal opens the GUI:
 {{{
 #!table style="border:none;vertical-align:top;text-align:left;width:750px"
@@ -52 +64 @@
   }}}
 }}}
+Make your selections and click '''palmrun'''. A terminal window will appear with some messages. If this doesn't work, copy and paste the command into the terminal.
 
-If this doesn't work, copy and paste the command into the terminal.
+== Create and run a new setup ==
+(1) Create a new directory
+{{{
+  cd $HOME/palm/current_version/JOBS
+  mkdir -p <new_run_identifier>/INPUT
+}}}
+(2) Create a new parameter file {{{<new_run_identifier>_p3d}}} with your own parameter settings under
+{{{
+  $HOME/palm/current_version/JOBS/<new_run_identifier>/INPUT
+}}}
+(3) Submit palmrun command
+{{{
+  palmrun -r <new_run_identifier>  -a d3#  -c default -X 4 -T 4
+}}}
+(4) The [wiki:doc/app/palmrun#interactive terminal output] tells you if everything went fine, and if so, where to find the output files.