make the technical docu more complete by adding musrStep and musrWiz.
All checks were successful
Build and Deploy Documentation / build-and-deploy (push) Successful in 17s
All checks were successful
Build and Deploy Documentation / build-and-deploy (push) Successful in 17s
This commit is contained in:
19
doc/musrStep.dox
Normal file
19
doc/musrStep.dox
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
/*********************************************************************************************
|
||||||
|
|
||||||
|
name: musrStep.dox
|
||||||
|
|
||||||
|
created by: Andreas Suter, 2025/11/24
|
||||||
|
|
||||||
|
content: Description of musrStep
|
||||||
|
|
||||||
|
**********************************************************************************************/
|
||||||
|
|
||||||
|
/**
|
||||||
|
|
||||||
|
\mainpage musrStep
|
||||||
|
|
||||||
|
<p>musrStep allows to reset the \<step\> values of the msr-file after a fit which went wrong. For instance this
|
||||||
|
this is necessary for high-field muSR data, since these values might be too small for the next
|
||||||
|
fit step.
|
||||||
|
|
||||||
|
*/
|
||||||
2930
doc/musrStep_qt6_dox.cfg
Normal file
2930
doc/musrStep_qt6_dox.cfg
Normal file
File diff suppressed because it is too large
Load Diff
18
doc/musrWiz.dox
Normal file
18
doc/musrWiz.dox
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
/*********************************************************************************************
|
||||||
|
|
||||||
|
name: musrWiz.dox
|
||||||
|
|
||||||
|
created by: Andreas Suter, 2025/11/24
|
||||||
|
|
||||||
|
content: Description of musrWiz
|
||||||
|
|
||||||
|
**********************************************************************************************/
|
||||||
|
|
||||||
|
/**
|
||||||
|
|
||||||
|
\mainpage musrWiz -- still on the level of concept
|
||||||
|
|
||||||
|
<p>musrWiz allows to generate an msr-file from scratch by going through a number of questions.
|
||||||
|
Currently only available for LEM.
|
||||||
|
|
||||||
|
*/
|
||||||
2931
doc/musrWiz_qt6_dox.cfg
Normal file
2931
doc/musrWiz_qt6_dox.cfg
Normal file
File diff suppressed because it is too large
Load Diff
@@ -12,7 +12,7 @@
|
|||||||
|
|
||||||
\mainpage musredit
|
\mainpage musredit
|
||||||
|
|
||||||
<p>musredit is a simple editor based interface to the musrfit programs. It is based on Qt5.x or Qt6.x (depending of your distro) of The Qt Company (<code>http://www.qt.io</code>).
|
<p>musredit is a simple editor based interface to the musrfit programs. It is based on Qt5.x (soon being deprecated) or Qt6.x (depending of your distro) of The Qt Company (<code>http://www.qt.io</code>).
|
||||||
|
|
||||||
<p>musredit is free software liensenced under GPL 2 or later (for detail license informations see
|
<p>musredit is free software liensenced under GPL 2 or later (for detail license informations see
|
||||||
<code>http://www.gnu.org/licenses</code>).
|
<code>http://www.gnu.org/licenses</code>).
|
||||||
|
|||||||
@@ -47,10 +47,12 @@ under Linux, Mac OS X, and (with some more work) under Windows. The musrfit fram
|
|||||||
msr-files with the same parameters and summarize the fitting results either in a TRIUMF DB or a column ASCII file.
|
msr-files with the same parameters and summarize the fitting results either in a TRIUMF DB or a column ASCII file.
|
||||||
- **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.
|
||||||
- **musredit**: an editor to handle msr-files, calling musrfit, etc. from within a simple text editor, based on Qt5.x or Qt6.x. A technical documentation of musredit can be found
|
- **musredit**: an editor to handle msr-files, calling musrfit, etc. from within a simple text editor, based on Qt5.x (soon being deprecated) or Qt6.x. A technical documentation of musredit can be found
|
||||||
\htmlonly <a href="./musredit/html/index.html">here.</a>\endhtmlonly
|
\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. A technical documentation of musrWiz can be found
|
||||||
- **musrStep**: allows to efficiently deal with initial step values of msr-files. Especially useful for msr-files dealing with many runs/detectors.
|
\htmlonly <a href="./musrWiz/html/index.html">here.</a>\endhtmlonly
|
||||||
|
- **musrStep**: allows to efficiently deal with initial step values of msr-files. Especially useful for msr-files dealing with many runs/detectors. A technical documentation of musrStep can be found
|
||||||
|
\htmlonly <a href="./musrStep/html/index.html">here.</a>\endhtmlonly
|
||||||
- **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
|
- **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
|
\htmlonly <a href="./mupp/html/index.html">here.</a>\endhtmlonly
|
||||||
- **addRun**: allows to add runs from the command line
|
- **addRun**: allows to add runs from the command line
|
||||||
|
|||||||
@@ -2280,7 +2280,9 @@ SKIP_FUNCTION_MACROS = YES
|
|||||||
# run, you must also specify the path to the tagfile here.
|
# run, you must also specify the path to the tagfile here.
|
||||||
|
|
||||||
TAGFILES = dox-tags/musredit.tag=musredit/html \
|
TAGFILES = dox-tags/musredit.tag=musredit/html \
|
||||||
dox-tags/mupp.tag=mupp/html
|
dox-tags/mupp.tag=mupp/html \
|
||||||
|
dox-tags/musrStep.tag=musrStep/html \
|
||||||
|
dox-tags/musrWiz.tag=musrWiz/html
|
||||||
|
|
||||||
# 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
|
||||||
|
|||||||
Reference in New Issue
Block a user