From 8c8833f2eb31b81b61c5317278a35b057f722798 Mon Sep 17 00:00:00 2001 From: Andreas Suter Date: Fri, 23 Dec 2011 08:35:50 +0000 Subject: [PATCH] updated docu --- doc/html/user/MUSR/BmwLibs.html | 47 ++++- doc/html/user/MUSR/LibFitPofB.html | 47 ++++- doc/html/user/MUSR/LibZFRelaxation.html | 47 ++++- doc/html/user/MUSR/Msr2Data.html | 73 +++++++- doc/html/user/MUSR/MusrFit.html | 160 ++++++++++++++-- .../user/MUSR/MusrFitAcknowledgements.html | 47 ++++- doc/html/user/MUSR/MusrFitSetup.html | 52 +++++- doc/html/user/MUSR/MusrGui.html | 173 +++++++++++++++++- doc/html/user/MUSR/QuickStart.html | 47 ++++- doc/html/user/MUSR/TutorialSingleHisto.html | 128 ++++++++++++- doc/html/user/MUSR/WebHome.html | 53 ++++-- .../user/pub/System/PatternSkin/print.css | 2 +- .../user/pub/System/PsiSkin/psicolors.css | 12 ++ doc/html/user/pub/System/PsiSkin/psistyle.css | 6 + doc/musrfit.dox | 44 +++-- doc/musrfit_dox.cfg | 4 +- 16 files changed, 809 insertions(+), 133 deletions(-) diff --git a/doc/html/user/MUSR/BmwLibs.html b/doc/html/user/MUSR/BmwLibs.html index 8878872c..b9d6f6f2 100644 --- a/doc/html/user/MUSR/BmwLibs.html +++ b/doc/html/user/MUSR/BmwLibs.html @@ -1,7 +1,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -111,7 +111,8 @@ pre { - + +
@@ -129,30 +130,56 @@ pre {

-- BMW & AS

-
-
-This topic: MUSR > WebHome > MusrFit > BmwLibs
-Topic revision: r5 - 10 Jul 2011 - 17:49:32 - BastianWojek + +

+
+

 
-
Ideas, requests, problems regarding PSI Wiki? Send feedback
+
Ideas, requests, problems regarding PSI Wiki? Send feedback

+ +
+ +
+
+
+ + + + + + + + + + + + + + + + + +
Oscar Fridolin
Telefon:1234512345
E-Mail:oscarfridolin@psi.ch
Büro:WHGA/019
+
+
+

- +

-

\ No newline at end of file diff --git a/doc/html/user/MUSR/LibFitPofB.html b/doc/html/user/MUSR/LibFitPofB.html index 09a16180..2b1b32ce 100644 --- a/doc/html/user/MUSR/LibFitPofB.html +++ b/doc/html/user/MUSR/LibFitPofB.html @@ -1,7 +1,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -111,7 +111,8 @@ pre { - + +
@@ -405,30 +406,56 @@ An example XML file looks as follows:

-- BMW & AS

-
-
-This topic: MUSR > WebHome > MusrFit > BmwLibs > LibFitPofB
-Topic revision: r16 - 10 Jul 2011 - 17:49:49 - BastianWojek + +

+
+

 
-
Ideas, requests, problems regarding PSI Wiki? Send feedback
+
Ideas, requests, problems regarding PSI Wiki? Send feedback

+ +
+ +
+
+
+ + + + + + + + + + + + + + + + + +
Oscar Fridolin
Telefon:1234512345
E-Mail:oscarfridolin@psi.ch
Büro:WHGA/019
+
+
+

- +

-

\ No newline at end of file diff --git a/doc/html/user/MUSR/LibZFRelaxation.html b/doc/html/user/MUSR/LibZFRelaxation.html index 6ab21d80..736f1071 100644 --- a/doc/html/user/MUSR/LibZFRelaxation.html +++ b/doc/html/user/MUSR/LibZFRelaxation.html @@ -1,7 +1,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -111,7 +111,8 @@ pre { - + +
@@ -210,30 +211,56 @@ The parameters are:

    -- BMW & AS

-
-
-This topic: MUSR > WebHome > MusrFit > BmwLibs > LibZFRelaxation
-Topic revision: r2 - 10 Jul 2011 - 17:50:10 - BastianWojek + +

+
+

 
-
Ideas, requests, problems regarding PSI Wiki? Send feedback
+
Ideas, requests, problems regarding PSI Wiki? Send feedback

+ +
+ +
+
+
+ + + + + + + + + + + + + + + + + +
Oscar Fridolin
Telefon:1234512345
E-Mail:oscarfridolin@psi.ch
Büro:WHGA/019
+
+
+

- +

-

\ No newline at end of file diff --git a/doc/html/user/MUSR/Msr2Data.html b/doc/html/user/MUSR/Msr2Data.html index 673a5a26..dd97a9ab 100644 --- a/doc/html/user/MUSR/Msr2Data.html +++ b/doc/html/user/MUSR/Msr2Data.html @@ -1,7 +1,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -111,7 +111,8 @@ pre { - + +
@@ -344,30 +345,82 @@ For reporting bugs or requesting new features and improvements please use the

-- BMW & AS

-
-
-This topic: MUSR > WebHome > MusrFit > Msr2Data
-Topic revision: r38 - 20 Jul 2011 - 12:13:59 - BastianWojek + +

+
+

 
-
Ideas, requests, problems regarding PSI Wiki? Send feedback
+
Ideas, requests, problems regarding PSI Wiki? Send feedback

+ +
+ +
+
+
+ + + + + + + + + + + + + + + + + +
Oscar Fridolin
Telefon:1234512345
E-Mail:oscarfridolin@psi.ch
Büro:WHGA/019
+
+
+

- +

-

\ No newline at end of file diff --git a/doc/html/user/MUSR/MusrFit.html b/doc/html/user/MUSR/MusrFit.html index d3b4994b..f767f3ed 100644 --- a/doc/html/user/MUSR/MusrFit.html +++ b/doc/html/user/MUSR/MusrFit.html @@ -1,7 +1,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -111,7 +111,8 @@ pre { - + +
@@ -133,6 +134,8 @@ pre {
  • 2.4 musrparam
  • 2.5 musrfit_startup.xml
  • 2.6 msr2msr +
  • 2.7 any2many +
  • 2.8 nexus_dump
  • 3 Auxiliary Programs
  • 4 Description of the msr File Format
      @@ -346,6 +349,56 @@ A typical example then looks like: 
      msr2msr 8472-WKM.msr 8472-musrfit.msr
      If the input file has already the musrfit msr file structure, the output file will be just a copy of the input file.

      + +

      2.7 any2many

      +any2many is a muSR data file converter. Currently different facilities (PSI, TRIUMF, ISIS, J-PARC) are saving their muSR data files in different formats, or even worse some instruments are using other muSR data formats than others. The aim of any2many is that these files can be converted into each other. Of course only a subset of header information can be converted. +

      +Currently any2many can convert the following muSR data file formats:
        +
      • input formats: PSI-BIN (PSI bulk), ROOT (PSI LEM), MUD (TRIUMF), NeXus IDF1 and NeXus IDF2 (ISIS), PSI-MDU (PSI bulk internal only), WKM (outdated ascii file format). +
      • output formats: PSI-BIN, ROOT, MUD, NeXus1-HDF4, NeXus1-HDF5, NeXus1-XML, NeXus2-HDF4, NeXus2-HDF5, NeXus2-XML, WKM, ASCII +
      +

      +Since the goal was to create a very flexible converter tool, it has ample of options which will listed below, followed by many examples showing how to use it. The options:
      +
      -f <filenameList-input>
      where <filenameList-input> is a space separated list of file names (not starting with a '-'), e.g. 2010/lem10_his_0111.root 2010/lem10_his_0113.root. +
      -o <outputFileName>
      this option allows to given an output-file-name for the converted file. This option only makes sense if <filenameList-input> is a single input-file-name! +
      -r <runList-input>
      where <runList-input> is a list of run numbers separated by spaces of the form: <run1> <run2> <run3> etc., or a sequence of runs <runStart>-<runEnd>, e.g. 111-123. This option cannot be combined with -f and vice versa. +
      -t <in-template> <out-template>
      where <in-/out-template> are templates to generate real file names from run numbers. The following template tags can be used: [yy] for year, and [rrrr] for the run number. If the run number tag is used, the number of 'r' will give the number of digits used with leading zeros, e.g. [rrrrrr] and run 123 will result in 000123. Similarly [yyyy] will result in something like 1999, whereas [yy] into something like 99. For more details best check the examples below. +
      -c <in-Format> <out-Format>
      this is used to tell any2many what is the input-file-format and into which output-file-format the data shall be converted. The possible input-/output-file-formats are listed above. +
      -p <output-path>
      where <output-path> is the output path for the converted files. If no <output-path> is given, the current directory will be used, unless the option -s is used. +
      -y <year>
      here a <year> in the form yy or yyyy can be given. If this is the case, any automatic file name generation which needs a year will use this given one. +
      -s
      with this option the output data file will be sent to the stdout. It is intended to be used together with web applications. +
      -rebin <n>
      where <n> is the number of bins to be packed/rebinned. +
      -z [g|b] <compressed>
      where <compressed> is the output file name (without extension) of the compressed data collection, and 'g' will result in .tar.gz, and 'b' in .tar.bz2 files. +
      --help
      displays a help notice in the shell explaining the basic usage of the program. +
      --version
      shows the current SVN version of any2many. +
      +

      +If the template option '-t' is absent, the output file name will be generated according to the input data file name (not possible with <runList-input>), and the output data format. +

      +Here now a couple of examples which should help to understand the switches. +

      +
      any2many -f 2010/lem10_his_0123.root -c ROOT ASCII -rebin 25
      +Will take the LEM ROOT file '2010/lem10_his_0123.root' rebin it by 25 and convert it to ASCII. The output file name will be lem10_his_0123.ascii, and the file will be saved in the current directory. The data in lem10_his_0123.ascii are written in columns. +

      +
      any2many -f 2010/lem10_his_0123.root -c ROOT NEXUS2-HDF5 -o 2010/lem10_his_0123_v2.nxs
      +Will take the LEM ROOT file '2010/lem10_his_0123.root' and convert it to NeXus IDF V2. The output file name will be lem10_his_0123_v2.nxs, and will be saved in the current directory. +

      +
      any2many -r 123 137 -c PSI-BIN MUD -t d[yyyy]/deltat_tdc_gps_[rrrr].bin [rrrrrr].msr -y 2001
      +Will take the run 123 and 137, will generate the input file names: d2001/deltat_tdc_gps_0123.bin and d2001/deltat_tdc_gps_0137.bin, read these files, and convert them to the output files with names 000123.msr and 000137.msr, respectively. +

      +
      any2many -r 100-117 -c PSI-MDU ASCII -t d[yyyy]/deltat_tdc_alc_[rrrr].mdu [rrr].ascii -y 2011 -s
      +Will take the runs 100 through 117 and convert the PSI-MDU input files to ASCII output and instead of saving them into a file, they will be spit to the standard output. +

      +
      any2many -r 100-117 -c NEXUS ROOT -t d[yyyy]/psi_gps_[rrrr].NXS psi_[yyyy]_gps_[rrrr].root -z b psi_gps_run_100to117
      +Will take the runs 100 through 117 and convert the NeXus input files to ROOT output. Afterwards these new files will be collected in a compressed archive psi_gps_run_100to117.tar.bz2. +

      +
      any2many -f 2010/lem10_his_0123.root 2010/lem10_his_0012.root -c ROOT ROOT -rebin 25
      +Will read the two files '2010/lem10_his_0123.root' and '2010/lem10_his_0012.root', rebin them with 25 and export them as LEM ROOT files with adding rebin25 to the name, e.g. 2010/lem10_his_0123_rebin25.root. +

      + +

      2.8 nexus_dump

      +nexus_dump is a little program which tries to read a NeXus file and send the relevant information (required header info, start of the histos, etc.) to the standard output. +

      3 Auxiliary Programs

      Additionally to the programs mentioned above editor front ends called musrgui/musredit and another tool named msr2data are available. The purpose of msr2data is to process multiple msr files with the same parameters and to summarize the fitting results either in a DB or a column ASCII file. Also, new msr files can be generated from a template. For details refer to its manual. @@ -796,8 +849,9 @@ etc.

      forward (fit type 0)
      Number of the histogram in the data file to be processed. If histograms shall be grouped, all the numbers which shall be grouped. Examples: 
      -  forward 3   # no grouping, take histogram number 3
-  forward 1 2 # group histogram number 1 and 2
+  forward 3       # no grouping, take histogram number 3
+  forward 1 2     # group histogram number 1 and 2
+  forward 1-10 12 # group histograms with numbers from 1 to 10 and additionally histogram 12

      @@ -808,6 +862,9 @@ etc. # build forward/backward asymmetry with groupings 1+2+3 and 7+8+9 forward 1 2 3 backward 7 8 9 + # build forward/backward asymmetry with groupings 1+2+3 and 7+8+9 (alternative notation) + forward 1-3 + backward 7-9

      @@ -1335,12 +1392,58 @@ A technical description of the musrfit framework can be found PSI Tracker or send an e-mail to A. Suter.

      --- BMW & AS
    • +-- AS & BMW
    +

    + +

    +

    - -
    -This topic: MUSR > WebHome > MusrFit
    -Topic revision: r96 - 02 Sep 2011 - 19:02:28 - BastianWojek @@ -1351,11 +1454,42 @@ Topic revision: r96 - 02 Sep 2011 - 19:02:28 - + + +
    +
    + + + + + + + + + + + + + + + + + +
    Oscar Fridolin
    Telefon:1234512345
    E-Mail:oscarfridolin@psi.ch
    Büro:WHGA/019
    +
    +

    - +

    + - + - \ No newline at end of file + +

    +

    +

    +

    \ No newline at end of file diff --git a/doc/html/user/MUSR/MusrFitAcknowledgements.html b/doc/html/user/MUSR/MusrFitAcknowledgements.html index 768a2cc9..6a95340d 100644 --- a/doc/html/user/MUSR/MusrFitAcknowledgements.html +++ b/doc/html/user/MUSR/MusrFitAcknowledgements.html @@ -1,7 +1,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -111,7 +111,8 @@ pre { - + +
    @@ -127,30 +128,56 @@ pre {

    -- BMW & AS

    -
    -
    -This topic: MUSR > WebHome > MusrFit > MusrFitAcknowledgements
    -Topic revision: r4 - 10 Jul 2011 - 17:50:36 - BastianWojek + +

    +
    +

     
    -
    Ideas, requests, problems regarding PSI Wiki? Send feedback
    +
    Ideas, requests, problems regarding PSI Wiki? Send feedback

    + +
    + +
    +
    +
    + + + + + + + + + + + + + + + + + +
    Oscar Fridolin
    Telefon:1234512345
    E-Mail:oscarfridolin@psi.ch
    Büro:WHGA/019
    +
    +
    +

    - +

    -

    \ No newline at end of file diff --git a/doc/html/user/MUSR/MusrFitSetup.html b/doc/html/user/MUSR/MusrFitSetup.html index 0fe0c9e8..1c2d5d14 100644 --- a/doc/html/user/MUSR/MusrFitSetup.html +++ b/doc/html/user/MUSR/MusrFitSetup.html @@ -1,7 +1,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -111,7 +111,8 @@ pre { - + +
    @@ -234,7 +235,7 @@ Even though there might exist binary packages for the NeXus library The ROOT system may or may not be part of the GNU/Linux distribution. If it is, it should be checked that the provided binaries are of a recent version and then these in principle can be installed using a package manager as described above.
    In case the distribution provides no or only outdated binary packages there are the following possibilities:
    • Visit the ROOT web page and download the packed precompiled binary version matching best the GNU/Linux distribution. Then unpack the bundle to its final destination. -
    • If there is no precompiled binary version of ROOT available for your system or e.g. ROOT should be compiled with another version of GCC visit the web page and download the 'complete source tree for all systems'. Then unpack this source tree to its destination (e.g. /opt/root-system)(1), configure(2) it (here using the minimal set of options) and compile it as follows right below: 
      +
    • If there is no precompiled binary version of ROOT available for your system or e.g. ROOT should be compiled with another version of GCC visit the web page and download the 'complete source tree for all systems'. Then unpack this source tree to its destination (e.g. /opt/root-system)(1), configure(2) it (here using the minimal set of options) and compile it as follows right below: 
       cd /opt/root-system
 ./configure linux --gminimal --enable-asimage --enable-mathmore --enable-minuit2 --enable-xml
             (or in case of a 64 bit installation: ./configure linuxx8664gcc --gminimal --enable-asimage --enable-mathmore --enable-minuit2 --enable-xml)
@@ -803,10 +804,10 @@ musrview test-histo-ROOT-NPP.msr
 
      
 -- BMW & AS

    -
    -
    -This topic: MUSR > WebHome > MusrFit > MusrFitSetup
    -Topic revision: r50 - 28 Aug 2011 - 11:56:04 - BastianWojek + +

    +
    +

    @@ -817,11 +818,42 @@ Topic revision: r50 - 28 Aug 2011 - 11:56:04 - + + +
    +
    + + + + + + + + + + + + + + + + + +
    Oscar Fridolin
    Telefon:1234512345
    E-Mail:oscarfridolin@psi.ch
    Büro:WHGA/019
    +
    +
    +

    - + - \ No newline at end of file + +

    +

    +

    +

    \ No newline at end of file diff --git a/doc/html/user/MUSR/MusrGui.html b/doc/html/user/MUSR/MusrGui.html index 4a22bf9a..916bb4b3 100644 --- a/doc/html/user/MUSR/MusrGui.html +++ b/doc/html/user/MUSR/MusrGui.html @@ -1,7 +1,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -111,7 +111,8 @@ pre { - + +
    @@ -316,30 +317,182 @@ For reporting bugs or requesting new features and improvements please use the

    --     BMW & AS

    -
    -
    -This topic: MUSR > WebHome > MusrFit > MusrGui
    -Topic revision: r18 - 20 Jul 2011 - 12:22:56 - BastianWojek + +

    +
    +

     
    -
    Ideas, requests, problems regarding PSI Wiki? Send feedback
    +
    Ideas, requests, problems regarding PSI Wiki? Send feedback

    + +
    + +
    +
    +
    + + + + + + + + + + + + + + + + + +
    Oscar Fridolin
    Telefon:1234512345
    E-Mail:oscarfridolin@psi.ch
    Büro:WHGA/019
    +
    +
    +

    - +

    -

    \ No newline at end of file diff --git a/doc/html/user/MUSR/QuickStart.html b/doc/html/user/MUSR/QuickStart.html index 942c7420..7b8b045b 100644 --- a/doc/html/user/MUSR/QuickStart.html +++ b/doc/html/user/MUSR/QuickStart.html @@ -1,7 +1,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -111,7 +111,8 @@ pre { - + +
    @@ -265,30 +266,56 @@ RUN 2008/lem08_his_8472 MUE4 PSI ROOT-NPP (name beamline institute dat

    -- BMW & AS

    -
    -
    -This topic: MUSR > WebHome > MusrFit > QuickStart
    -Topic revision: r7 - 10 Jul 2011 - 17:48:19 - BastianWojek + +

    +
    +

     
    -
    Ideas, requests, problems regarding PSI Wiki? Send feedback
    +
    Ideas, requests, problems regarding PSI Wiki? Send feedback

    + +
    + +
    +
    +
    + + + + + + + + + + + + + + + + + +
    Oscar Fridolin
    Telefon:1234512345
    E-Mail:oscarfridolin@psi.ch
    Büro:WHGA/019
    +
    +
    +

    - +

    -

    \ No newline at end of file diff --git a/doc/html/user/MUSR/TutorialSingleHisto.html b/doc/html/user/MUSR/TutorialSingleHisto.html index 7c493532..c2566199 100644 --- a/doc/html/user/MUSR/TutorialSingleHisto.html +++ b/doc/html/user/MUSR/TutorialSingleHisto.html @@ -1,7 +1,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -111,7 +111,8 @@ pre { - + +
    @@ -276,10 +277,86 @@ This page only summarizes the very basic features and options of the programs co

    -- BMW & AS

    -
    -
    -This topic: MUSR > TutorialSingleHisto
    -Topic revision: r9 - 02 Sep 2011 - 19:10:07 - BastianWojek + +

    +
    +

    @@ -290,11 +367,42 @@ Topic revision: r9 - 02 Sep 2011 - 19:10:07 - + + +
    +
    + + + + + + + + + + + + + + + + + +
    Oscar Fridolin
    Telefon:1234512345
    E-Mail:oscarfridolin@psi.ch
    Büro:WHGA/019
    +
    +

    - +

    + - + - \ No newline at end of file + +

    +

    +

    +

    \ No newline at end of file diff --git a/doc/html/user/MUSR/WebHome.html b/doc/html/user/MUSR/WebHome.html index 0ba1c68b..df8494cc 100644 --- a/doc/html/user/MUSR/WebHome.html +++ b/doc/html/user/MUSR/WebHome.html @@ -1,7 +1,7 @@ - + @@ -21,7 +21,7 @@ - + @@ -111,7 +111,8 @@ pre { - + +
    -
    -This topic: MUSR > WebHome
    -Topic revision: r22 - 30 Jul 2011 - 13:41:15 - BastianWojek
     
    -
    Ideas, requests, problems regarding PSI Wiki? Send feedback
    +
    Ideas, requests, problems regarding PSI Wiki? Send feedback

    + +
    + +
    +
    +
    + + + + + + + + + + + + + + + + + +
    Oscar Fridolin
    Telefon:1234512345
    E-Mail:oscarfridolin@psi.ch
    Büro:WHGA/019
    +
    +
    +

    - +

    -

    \ No newline at end of file diff --git a/doc/html/user/pub/System/PatternSkin/print.css b/doc/html/user/pub/System/PatternSkin/print.css index 01de1c44..8ed8ce87 100644 --- a/doc/html/user/pub/System/PatternSkin/print.css +++ b/doc/html/user/pub/System/PatternSkin/print.css @@ -1 +1 @@ -body{margin:0;padding:0;}#patternScreen, #patternPageShadow, #patternPage, #patternOuter{margin:0;padding:0;top:0;border:none;float:none;}#patternMain{width:100%;float:none;display:inline;overflow:visible;}#patternSideBar{display:none;}#patternWrapper{height:1%;}#patternTopBar, #patternClearHeaderCenter, #patternClearHeaderLeft, #patternClearHeaderRight, #patternTopBarContentsOuter{display:none;}.patternTopicAction, .patternToolBar, .patternToolBarBottom, .patternHomePath img, .patternHomePathTitle, .foswikiActionFormStepSign{display:none;}#patternMainContents{margin:0;padding:1em 2em;}#patternBottomBar{border:none;}.patternTopicFooter{margin:1em 0 0 0;}#attachmentsshow, #attachmentshide{display:none;}pre, html>body pre{overflow:visible !important;}h1, h2, h3, h4, h5, h6{page-break-after:avoid;page-break-inside:avoid;}img{page-break-inside:avoid;page-break-after:avoid;}blockquote, table, pre{page-break-inside:avoid;}ul, ol, dl{page-break-before:avoid;}.commentPlugin{display:none;}.twistyTrigger{display:none;}.editTableEditImageButton{display:none;}html body{background-color:#fff;}h2, h3, h4, h5, h6{background-color:transparent;}#patternBottomBar{background-color:transparent;}pre, code, tt{color:#5b4221;}.foswikiTable th{border-style:solid;border-width:0 0 1px 1px;border-color:#ccc;color:#000;}.foswikiTable th a:link, .foswikiTable th a:visited, .foswikiTable th a font, .foswikiAttachments .foswikiTable th a:link, .foswikiAttachments .foswikiTable th a:visited, .foswikiAttachments .foswikiTable th a font{color:#000;text-decoration:none;}:visited, .foswikiTopic a:visited{color:#06c;background-color:transparent;}.foswikiAttachments, .patternContent .foswikiAttachments, .foswikiForm, .patternContent .foswikiForm{background-color:#fff;}.patternRevInfo, .foswikiGrayText{color:#666;}.patternRevInfo a:link, .patternRevInfo a:visited .foswikiGrayText a:link, .foswikiGrayText a:visited{color:#666;}@media print{body{margin:0;padding:0;}#patternScreen, #patternPageShadow, #patternPage, #patternOuter{margin:0;padding:0;top:0;border:none;float:none;}#patternMain{width:100%;float:none;display:inline;overflow:visible;}#patternSideBar{display:none;}#patternWrapper{height:1%;}#patternTopBar, #patternClearHeaderCenter, #patternClearHeaderLeft, #patternClearHeaderRight, #patternTopBarContentsOuter{display:none;}.patternTopicAction, .patternToolBar, .patternToolBarBottom, .patternHomePath img, .patternHomePathTitle, .foswikiActionFormStepSign{display:none;}#patternMainContents{margin:0;padding:1em 2em;}#patternBottomBar{border:none;}.patternTopicFooter{margin:1em 0 0 0;}#attachmentsshow, #attachmentshide{display:none;}pre, html>body pre{overflow:visible !important;}h1, h2, h3, h4, h5, h6{page-break-after:avoid;page-break-inside:avoid;}img{page-break-inside:avoid;page-break-after:avoid;}blockquote, table, pre{page-break-inside:avoid;}ul, ol, dl{page-break-before:avoid;}.commentPlugin{display:none;}.twistyTrigger{display:none;}.editTableEditImageButton{display:none;}html body{background-color:#fff;}h2, h3, h4, h5, h6{background-color:transparent;}#patternBottomBar{background-color:transparent;}pre, code, tt{color:#5b4221;}.foswikiTable th{border-style:solid;border-width:0 0 1px 1px;border-color:#ccc;color:#000;}.foswikiTable th a:link, .foswikiTable th a:visited, .foswikiTable th a font, .foswikiAttachments .foswikiTable th a:link, .foswikiAttachments .foswikiTable th a:visited, .foswikiAttachments .foswikiTable th a font{color:#000;text-decoration:none;}:visited, .foswikiTopic a:visited{color:#06c;background-color:transparent;}.foswikiAttachments, .patternContent .foswikiAttachments, .foswikiForm, .patternContent .foswikiForm{background-color:#fff;}.patternRevInfo, .foswikiGrayText{color:#666;}.patternRevInfo a:link, .patternRevInfo a:visited .foswikiGrayText a:link, .foswikiGrayText a:visited{color:#666;}} \ No newline at end of file +body{margin:0;padding:0;}#patternScreen, #patternPageShadow, #patternPage, #patternOuter{margin:0;padding:0;top:0;border:none;float:none;}#patternMain{width:100%;float:none;display:inline;overflow:visible;}#patternSideBar{display:none;}#patternWrapper{height:1%;}#patternTopBar, #patternClearHeaderCenter, #patternClearHeaderLeft, #patternClearHeaderRight, #patternTopBarContentsOuter{display:none;}.patternTopicAction, .patternToolBar, .patternToolBarBottom, .patternHomePath img, .patternHomePathTitle, .foswikiActionFormStepSign{display:none;}#patternMainContents{margin:0;padding:1em 2em;}#patternBottomBar{border:none;}.patternTopicFooter{margin:1em 0 0 0;}#attachmentsshow, #attachmentshide{display:none;}pre, html>body pre{overflow:visible !important;}h1, h2, h3, h4, h5, h6{page-break-after:avoid;page-break-inside:avoid;}img{page-break-inside:avoid;page-break-after:avoid;}blockquote, table, pre{page-break-inside:avoid;}ul, ol, dl{page-break-before:avoid;}.commentPlugin{display:none;}.twistyTrigger{display:none;}.editTableEditImageButton{display:none;}html body{background-color:#fff;}h2, h3, h4, h5, h6{background-color:transparent;}#patternBottomBar{background-color:transparent;}pre, code, tt{color:#5b4221;}.foswikiTable th{border-style:solid;border-width:0 0 1px 1px;border-color:#ccc;color:#000;}.foswikiTable th a:link, .foswikiTable th a:visited, .foswikiTable th a font, .foswikiAttachments .foswikiTable th a:link, .foswikiAttachments .foswikiTable th a:visited, .foswikiAttachments .foswikiTable th a font{color:#000;text-decoration:none;}:visited, .foswikiTopic a:visited{color:#06c;background-color:transparent;}.foswikiAttachments, .patternContent .foswikiAttachments, .foswikiForm, .patternContent .foswikiForm{background-color:#fff;}.patternRevInfo, .foswikiGrayText{color:#666;}.patternRevInfo a:link, .patternRevInfo a:visited .foswikiGrayText a:link, .foswikiGrayText a:visited{color:#666;}@media print{body{margin:0;padding:0;}#patternScreen, #patternPageShadow, #patternPage, #patternOuter{margin:0;padding:0;top:0;border:none;float:none;}#patternMain{width:100%;float:none;display:inline;overflow:visible;}#patternSideBar{display:none;}#patternWrapper{height:1%;}#patternTopBar, #patternClearHeaderCenter, #patternClearHeaderLeft, #patternClearHeaderRight, #patternTopBarContentsOuter{display:none;}.patternTopicAction, .patternToolBar, .patternToolBarBottom, .patternHomePath img, .patternHomePathTitle, .foswikiActionFormStepSign{display:none;}#patternMainContents{margin:0;padding:1em 2em;}#patternBottomBar{border:none;}.patternTopicFooter{margin:1em 0 0 0;}#attachmentsshow, #attachmentshide{display:none;}pre, html>body pre{overflow:visible !important;}h1, h2, h3, h4, h5, h6{page-break-after:avoid;page-break-inside:avoid;}img{page-break-inside:avoid;page-break-after:avoid;}blockquote, table, pre{page-break-inside:avoid;}ul, ol, dl{page-break-before:avoid;}.commentPlugin{display:none;}.twistyTrigger{display:none;}.editTableEditImageButton{display:none;}html body{background-color:#fff;}h2, h3, h4, h5, h6{background-color:transparent;}#patternBottomBar{background-color:transparent;}pre, code, tt{color:#5b4221;}.foswikiTable th{border-style:solid;border-width:0 0 1px 1px;border-color:#ccc;color:#000;}.foswikiTable th a:link, .foswikiTable th a:visited, .foswikiTable th a font, .foswikiAttachments .foswikiTable th a:link, .foswikiAttachments .foswikiTable th a:visited, .foswikiAttachments .foswikiTable th a font{color:#000;text-decoration:none;}:visited, .foswikiTopic a:visited{color:#06c;background-color:transparent;}.foswikiAttachments, .patternContent .foswikiAttachments, .foswikiForm, .patternContent .foswikiForm{background-color:#fff;}.patternRevInfo, .foswikiGrayText{color:#666;}.patternRevInfo a:link, .patternRevInfo a:visited .foswikiGrayText a:link, .foswikiGrayText a:visited{color:#666;}} #peopleIcon {display: none;} #tooltip {display: none;} diff --git a/doc/html/user/pub/System/PsiSkin/psicolors.css b/doc/html/user/pub/System/PsiSkin/psicolors.css index f457cc16..8d07ef23 100644 --- a/doc/html/user/pub/System/PsiSkin/psicolors.css +++ b/doc/html/user/pub/System/PsiSkin/psicolors.css @@ -80,4 +80,16 @@ h1 { border: 2px solid #FFCC33; padding: 0 10px; margin-bottom: 15px; +} + +.patternTopicActions a:link .foswikiAccessKey, +.patternTopicActions a:visited .foswikiAccessKey { + border-color: #000000; + color: #000000; +} + +.patternTopicActions a:link:hover .foswikiAccessKey, +.patternTopicActions a:visited:hover .foswikiAccessKey { + border-color: #FFFFFF; + color: #FFFFFF; } \ No newline at end of file diff --git a/doc/html/user/pub/System/PsiSkin/psistyle.css b/doc/html/user/pub/System/PsiSkin/psistyle.css index b765728b..6bd13c22 100644 --- a/doc/html/user/pub/System/PsiSkin/psistyle.css +++ b/doc/html/user/pub/System/PsiSkin/psistyle.css @@ -214,3 +214,9 @@ q:after { content:close-quote; color:#000000; } .restriction ul { margin-bottom: 0; } + +p, dd { + -webkit-hyphens: auto; + -moz-hyphens: auto; + hyphens: auto; +} \ No newline at end of file diff --git a/doc/musrfit.dox b/doc/musrfit.dox index 036499af..eced5d4c 100644 --- a/doc/musrfit.dox +++ b/doc/musrfit.dox @@ -18,18 +18,18 @@

    People merely intrested in the handling of the programs should check this link: \htmlonly -musrfit user manual +musrfit user manual \endhtmlonly \latexonly -musrfit user manual: \texttt{https://intranet.psi.ch/MUSR/MusrFit} +musrfit user manual: \texttt{http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFit.html} \endlatexonly

    People which would like to know how to install the musrfit framework, please check this link: \htmlonly -How to setup musrfit on different platforms +How to setup musrfit on different platforms \endhtmlonly \latexonly -How to setup musrfit on different platforms: \texttt{https://intranet.psi.ch/MUSR/MusrFitSetup} +How to setup musrfit on different platforms: \texttt{http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFitSetup.html} \endlatexonly //**************************************************************************************************** @@ -49,11 +49,14 @@ How to setup musrfit on different platforms: \texttt{https://intranet.psi.ch/MUS - \ref musredit An editor to handle msr-files, calling musrfit, etc. from within a simple text editor, based on >= Qt4.6. - \ref MuSRFit A graphical user interface based on PerlQt (written by Z. Salman) for an easy to use interface to the musrfit framework. Compared to the more general approach of writting msr-files, it has some limitations, though it might be easier for a first user of the musrfit framework. +- \ref any2many Should be a "universal" muSR data-file-format converter. +- \ref nexus_dump Is a small program to dump NeXus file information (mainly run header info) to the standard output. \section roadmap Road map and missing features +

    Support for NeXus files is underway and should be fully available from early 2012 on. +

    The following features should eventually be implemented, but are still missing: -- support for NeXuS files. Reason: As soon as ISIS and PSI will support this file type, musrfit will do as well - there are still issues with MUD files on 64bit systems which should eventually be fixed. - non-muSR: The plan is to add an option to fit/plot \f$f(x_1,\ldots,x_n)\f$ versus \f$g(x_1,\ldots,x_n)\f$, where \f$x_i\f$ is a given data set element. - mu-Minus: The handling for \f$\mu_{-}\f$ fits is still missing and should be implemented. @@ -73,57 +76,70 @@ This two points are somewhat contradictory, and currently it is not clear which \section bugs How to report bugs -

    Bugs, unexpected features, can be reported directly to me: \verbatim andreas.suter@psi.ch, \endverbatim or entered in the bug-tracking tool at PSI \verbatim https://tracker.intranet.psi.ch/ \endverbatim. +

    Bugs, unexpected features, can be reported directly to me: \verbatim andreas.suter@psi.ch, \endverbatim or entered in the bug-tracking tool at PSI \verbatim https://tracker.intranet.psi.ch/ \endverbatim (access to within +PSI firewall required). //**************************************************************************************************** \page musrfitPage \section musrfit musrfit -

    Here will eventually follow a more technical description of musrfit. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{https://intranet.psi.ch/MUSR/MusrFit} \endlatexonly +

    Here will eventually follow a more technical description of musrfit. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFit.html} \endlatexonly //**************************************************************************************************** \page musrviewPage \section musrview musrview -

    Here will eventually follow a more technical description of musrview. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{https://intranet.psi.ch/MUSR/MusrFit} \endlatexonly +

    Here will eventually follow a more technical description of musrview. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFit.html} \endlatexonly //**************************************************************************************************** \page musrt0Page \section musrt0 musrt0 -

    Here will eventually follow a more technical description of musrt0. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{https://intranet.psi.ch/MUSR/MusrFit} \endlatexonly +

    Here will eventually follow a more technical description of musrt0. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFit.html} \endlatexonly //**************************************************************************************************** \page musrparamPage \section musrparam musrparam -

    Here will eventually follow a more technical description of musrparam. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{https://intranet.psi.ch/MUSR/MusrFit} \endlatexonly +

    Here will eventually follow a more technical description of musrparam. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFit.html} \endlatexonly //**************************************************************************************************** \page msr2dataPage \section msr2data msr2data -

    Here will eventually follow a more technical description of musr2data. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{https://intranet.psi.ch/MUSR/MusrFit} \endlatexonly +

    Here will eventually follow a more technical description of musr2data. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFit.html} \endlatexonly //**************************************************************************************************** \page msr2msrPage \section msr2msr msr2msr -

    Here will eventually follow a more technical description of msr2msr. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{https://intranet.psi.ch/MUSR/MusrFit} \endlatexonly +

    Here will eventually follow a more technical description of msr2msr. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFit.html} \endlatexonly //**************************************************************************************************** \page musrguiPage \section musrgui musrgui -

    Here will eventually follow a more technical description of musrgui. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{https://intranet.psi.ch/MUSR/MusrFit} \endlatexonly +

    Here will eventually follow a more technical description of musrgui. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFit.html} \endlatexonly //**************************************************************************************************** \page musreditPage \section musredit musredit -

    Here will eventually follow a more technical description of musredit. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{https://intranet.psi.ch/MUSR/MusrFit} \endlatexonly +

    Here will eventually follow a more technical description of musredit. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFit.html} \endlatexonly //**************************************************************************************************** \page MuSRFitPage \section MuSRFit MuSRFit + +//**************************************************************************************************** +\page any2manyPage +\section any2many any2many + +

    Here will eventually follow a more technical description of any2many. If you looking for a user-manual like description, please check \htmlonlymusrfit user manual\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFit.html} \endlatexonly + +//**************************************************************************************************** +\page nexusDumpPage +\section nexus_dump nexus_dump +

    This is a little help program which reads a NeXus file and dumps most of the relevant information to the standard output. + */ diff --git a/doc/musrfit_dox.cfg b/doc/musrfit_dox.cfg index 7763e5c7..47a2da9f 100644 --- a/doc/musrfit_dox.cfg +++ b/doc/musrfit_dox.cfg @@ -23,14 +23,14 @@ PROJECT_NAME = musrfit # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 0.8.0 +PROJECT_NUMBER = 0.9.0 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. -OUTPUT_DIRECTORY = ./ +OUTPUT_DIRECTORY = ./technical # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output