updated the technical documentation.
This commit is contained in:
parent
0314c1225b
commit
0fa40bbc73
2282
doc/mupp_dox.cfg
Normal file
2282
doc/mupp_dox.cfg
Normal file
File diff suppressed because it is too large
Load Diff
2280
doc/musredit_dox.cfg
Normal file
2280
doc/musredit_dox.cfg
Normal file
File diff suppressed because it is too large
Load Diff
@ -49,10 +49,12 @@ under Linux, Mac OS X, and (with some more work) under Windows. The musrfit fram
|
|||||||
- **msr2msr**: old WKM like msr-files can be transformed into musrfit style msr-files with this little program.
|
- **msr2msr**: old WKM like msr-files can be transformed into musrfit style msr-files with this little program.
|
||||||
- musrgui (obsolete): an editor to handle msr-files, calling musrfit, etc. from within the editor, based on Qt3.x.
|
- musrgui (obsolete): an editor to handle msr-files, calling musrfit, etc. from within the editor, based on Qt3.x.
|
||||||
Only bug fixing will be done on this version, and if you have >= Qt4.6 available you should use musredit instead.
|
Only bug fixing will be done on this version, and if you have >= Qt4.6 available you should use musredit instead.
|
||||||
- **musredit**: an editor to handle msr-files, calling musrfit, etc. from within a simple text editor, based on >= Qt4.6.
|
- **musredit**: an editor to handle msr-files, calling musrfit, etc. from within a simple text editor, based on >= Qt4.6. A technical documentation of musredit can be found
|
||||||
|
\htmlonly <a href="../musredit/html/index.html">here.</a>\endhtmlonly
|
||||||
- **musrWiz** (beta): allows to create an initial msr-file by a step-by-step instruction wizard.
|
- **musrWiz** (beta): allows to create an initial msr-file by a step-by-step instruction wizard.
|
||||||
- **musrStep**: allows to efficiently deal with initial step values of msr-files. Especially useful for msr-files dealing with many runs/detectors.
|
- **musrStep**: allows to efficiently deal with initial step values of msr-files. Especially useful for msr-files dealing with many runs/detectors.
|
||||||
- **mupp**: is the muSR parameter plotter. It allows to plot values in db- or dat-files (collections).
|
- **mupp**: is the muSR parameter plotter. It allows to plot values in db- or dat-files (collections). A technical documentation of mupp can be found
|
||||||
|
\htmlonly <a href="../mupp/html/index.html">here.</a>\endhtmlonly
|
||||||
- **MuSRFit**: a graphical user interface based on PerlQt (written by Z. Salman) for an easy to use interface to the musrfit framework.
|
- **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 writing msr-files, it has some limitations, though it might be easier for a first user of the musrfit framework.
|
Compared to the more general approach of writing msr-files, it has some limitations, though it might be easier for a first user of the musrfit framework.
|
||||||
- **any2many**: should be a "universal" muSR data-file-format converter.
|
- **any2many**: should be a "universal" muSR data-file-format converter.
|
||||||
|
@ -38,7 +38,7 @@ PROJECT_NAME = musrfit
|
|||||||
# could be handy for archiving the generated documentation or if some version
|
# could be handy for archiving the generated documentation or if some version
|
||||||
# control system is used.
|
# control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER = 1.5.2
|
PROJECT_NUMBER = 1.6.0
|
||||||
|
|
||||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||||
# for a project that appears at the top of each page and should give viewer a
|
# for a project that appears at the top of each page and should give viewer a
|
||||||
@ -800,7 +800,7 @@ INPUT = musrfit.dox \
|
|||||||
../src/musrt0.cpp \
|
../src/musrt0.cpp \
|
||||||
../src/musrview.cpp \
|
../src/musrview.cpp \
|
||||||
../src/musrRootValidation.cpp \
|
../src/musrRootValidation.cpp \
|
||||||
../src/write_musrRoot_runHeader.cpp
|
../src/write_musrRoot_runHeader.cpp \
|
||||||
|
|
||||||
# This tag can be used to specify the character encoding of the source files
|
# This tag can be used to specify the character encoding of the source files
|
||||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
||||||
@ -2030,7 +2030,8 @@ SKIP_FUNCTION_MACROS = YES
|
|||||||
# the path). If a tag file is not located in the directory in which doxygen is
|
# the path). If a tag file is not located in the directory in which doxygen is
|
||||||
# run, you must also specify the path to the tagfile here.
|
# run, you must also specify the path to the tagfile here.
|
||||||
|
|
||||||
TAGFILES =
|
TAGFILES = dox-tags/musredit.tag=./technical/musredit\
|
||||||
|
dox-tags/mupp.tag=./technical/mupp
|
||||||
|
|
||||||
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
|
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
|
||||||
# tag file that is based on the input files it reads. See section "Linking to
|
# tag file that is based on the input files it reads. See section "Linking to
|
||||||
|
19
src/musredit_qt5/mupp/mupp.dox
Normal file
19
src/musredit_qt5/mupp/mupp.dox
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
/*********************************************************************************************
|
||||||
|
|
||||||
|
name: mupp.dox
|
||||||
|
|
||||||
|
created by: Andreas Suter, 2020/05/19
|
||||||
|
|
||||||
|
content: Description of mupp
|
||||||
|
|
||||||
|
**********************************************************************************************/
|
||||||
|
|
||||||
|
/**
|
||||||
|
|
||||||
|
\mainpage mupp - muon parameter plotter
|
||||||
|
|
||||||
|
<p>mupp allows to quickly plot parameters found in db-/dat-files. db-/dat-files are typically generated by msr2data from msr-files after fitting. A db-/dat-file is a collection of fitting parameters from a collection of muSR measurements. For instance a db-/dat-file collects a full temperature scan, a field scan, an energy scan, etc.
|
||||||
|
|
||||||
|
mupp allows to load these collections, select parameters in a x/y fashion and allows to plot it. It furthermore allows to create new variables which are mathematical transformations of the parameter vectors of a collection.
|
||||||
|
|
||||||
|
*/
|
File diff suppressed because it is too large
Load Diff
Loading…
x
Reference in New Issue
Block a user