PYTHIA8/pythia8175/htmldoc/SaveSettings.html

   1 <html>
   2 <head>
   3 <title>Save Settings</title>
   4 <link rel="stylesheet" type="text/css" href="pythia.css"/>
   5 <link rel="shortcut icon" href="pythia32.gif"/>
   6 </head>
   7 <body>
   8
   9 <h2>Save Settings</h2>
  10
  11 The information on this webpage is only valid if you access the PHP
  12 dynamic webpages via a web browser, and does not apply to the static
  13 HTML equivalents. With PHP, all of the settings in the PYTHIA program
  14 are represented by radio buttons or fill-in boxes, that makes it easy
  15 for you to  construct a file with your desired changes. This file can
  16 then be read into PYTHIA by your main program to steer the whole run.
  17
  18 <h3>Basic instructions</h3>
  19
  20 The functionality of the PHP option is described in the following.
  21
  22 <p/>
  23 <table border="2" cellpadding="5"><td>
  24 </td></table>
  25
  26 <ul>
  27
  28 <p/><li>
  29 To begin with, you must specify a <b>(temporary) file name</b> in the
  30 box above. If the filename already exists on the server, you will be
  31 requested to pick a new name.</li>
  32
  33 <p/><li>
  34 Once you have <b>Submit</b>ted your filename, you can browse through the
  35 pages and make your selections. The values currently selected when you
  36 load the page are the default values.</li>
  37
  38 <p/><li>
  39 When you have finished making your changes to a particular page,
  40 you <b>must</b> click on <b>Save Settings</b> at the <b>bottom</b> of
  41 the page. This will write the changes to your temporary file. If you make
  42 a mistake, just repeat the procedure for that category again.<br>
  43
  44 <p/><li>
  45 When you have finished all the changes you need, return to this page
  46 and click <b>Finish File</b>.</li>
  47
  48 <p/><li>
  49 You will then get up a link, that you are asked to <b>right-click</b>
  50 with your mouse (or equivalent).</li>
  51
  52 <p/><li>
  53 In the menu that appears, pick the option <b>Save Link As</b>
  54 (or equivalent).</li>
  55
  56 <p/><li>
  57 You will now get up a file browser, for you to pick and <b>Save</b>
  58 the location and file name (the latter by default the same as the
  59 temporary file name).</li>
  60
  61 <p/><li>
  62 At any time, if you click the <b>RESET</b> button, your temporary
  63 file will be erased and you can start anew.</li>
  64
  65 <p/><li>
  66 Before you use a file, be sure to <b>check it visually</b> to confirm
  67 that you saved what you intended to. Minor corrections are easily made
  68 in a text editor.
  69 </li>
  70
  71 </ul>
  72
  73 <p/>
  74 <h3>Supplementary notes</h3>
  75
  76
  77 The documentation files exist in three versions.
  78 <ol>
  79
  80 <p/><li>
  81 As a set of <code>.xml</code> files, in the <code>xmldoc/</code>
  82 subdirectory. These are the master copies that no user ever should
  83 touch, but that are used to generate the variants below.</li>
  84
  85 <p/><li>
  86 As a set of <code>.html</code> files, in the <code>htmldoc/</code>
  87 subdirectory. You can open your own locally installed copy of the
  88 <code>Welcome.html</code> file in your web browser and thereafter
  89 navigate among all the pages. You can learn which parameters are free
  90 to be changed, but not change anything, except by brute-force
  91 cut-and-paste to a file of your own.</li>
  92
  93 <p/><li>
  94 As a set of <code>.php</code> files, in the <code>phpdoc/</code>
  95 subdirectory. For these files to provide the functionality described
  96 above they have to accessed via a webserver. The one where you have
  97 your homepage should work fine. Alternatively you can use pages already
  98 available on another server.</li>
  99
 100 </ol>
 101
 102 <p/>
 103 A few further comments about the operation of the PHP option:
 104 <ul>
 105
 106 <p/><li>
 107 To set up the PHP files on your webserver, you have to install the whole
 108 <code>phpdoc/</code> subdirectory there. In addition to the
 109 <code>.php</code> code this includes a few more files, plus a
 110 subdirectory named <code>files</code> where the temporary files
 111 are stored. This subdirectory must have public write access to work
 112 (<code>chmod a+w files</code> if not).</li>
 113
 114 <p/><li>
 115 The "temporary" files stored in <code>files</code> actually remain
 116 unless the RESET button is used. The good news is that this makes
 117 it possible to recover a file that otherwise might be lost. The bad
 118 news is that the <code>files</code> directory may need to be cleaned
 119 up from time to time. (But typically the files are pretty small, so
 120 this should not be a major problem.)</li>
 121
 122 <p/><li>
 123 When you click the <b>Save Settings</b> button on the bottom of a page
 124 all changed settings are written on the temporary file in the format
 125 <pre>
 126 name-of-flag/mode/parameter/word = value
 127 </pre>
 128 with one variable per line. Thereafter all the settings on the page
 129 are restored to their default values.</li>
 130
 131 <p/><li>
 132 You can return to a page to do some further changes and save those.
 133 If you change the same parameter twice, it is the last value that
 134 counts. (Both values are stored in the file, with the more recent
 135 lower down, and then PYTHIA does the changes sequentially.) However
 136 remember that unchanged values are not stored, so if you want to
 137 restore some default value it may be simpler to edit the file
 138 afterwards.</li>
 139
 140 <p/><li>
 141 The changeable flags/modes/parameters/words are mainly in the
 142 "Setup Run Tasks" section of the index, but a few (less
 143 frequently used ones) can also be found lower down, in the
 144 "Study Output" and "Link to Other Programs" pages.
 145
 146 <p/><li>
 147 It is not (yet) possible to modify particle data within the PHP-based
 148 setup approach. This is a more difficult task, since e.g. the
 149 modifications one may want to do in a decay table can be quite
 150 interrelated.
 151
 152 </body>
 153 </html>
 154
 155 <!-- Copyright (C) 2013 Torbjorn Sjostrand -->
 156