LMU/musrfit
5
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases 4 Activity

removed qmake leftovers. Only cmake is used for the future. Reorganized the technical docu, for better gitea-pages integration.

Browse Source
This commit is contained in:
suter_a
2025-09-02 08:55:00 +02:00
parent ed6e392a53
commit 7405a95c6e
18 changed files with 5704 additions and 1144 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/mupp.dox Normal file
View 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.
<p>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.
*/

11
doc/mupp_dox.cfg → doc/mupp_qt5_dox.cfg
View File

@@ -733,9 +733,10 @@ WARN_LOGFILE =
# spaces.
# Note: If this tag is empty the current directory is searched.
INPUT =../src/musredit_qt5/mupp \
../src/musredit_qt5/mupp/var/include \
../src/musredit_qt5/mupp/var/src
INPUT = ./ \
../src/musredit_qt5/mupp \
../src/musredit_qt5/mupp/var/include \
../src/musredit_qt5/mupp/var/src
# 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
@@ -755,7 +756,7 @@ INPUT_ENCODING = UTF-8
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
FILE_PATTERNS = *.dox *.cpp *.h *.hpp
FILE_PATTERNS = mupp.dox *.cpp *.h *.hpp
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
@@ -1532,7 +1533,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = YES
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

17
doc/musredit_dox.cfg → doc/mupp_qt6_dox.cfg
View File

@@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = "musredit"
PROJECT_NAME = "mupp"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 1.0.0
PROJECT_NUMBER = 1.1.0
# 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
@@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = ./technical/html/musredit
OUTPUT_DIRECTORY = ./technical/html/mupp
# 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 format and
@@ -733,7 +733,10 @@ WARN_LOGFILE =
# spaces.
# Note: If this tag is empty the current directory is searched.
INPUT =../src/musredit_qt5/musredit
INPUT = ./ \
../src/musredit_qt6/mupp \
../src/musredit_qt6/mupp/var/include \
../src/musredit_qt6/mupp/var/src
# 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
@@ -753,7 +756,7 @@ INPUT_ENCODING = UTF-8
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
FILE_PATTERNS = *.dox *.cpp *.h
FILE_PATTERNS = mupp.dox *.cpp *.h *.hpp
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
@@ -1530,7 +1533,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = YES
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -1969,7 +1972,7 @@ TAGFILES =
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = dox-tags/musredit.tag
GENERATE_TAGFILE = dox-tags/mupp.tag
# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
# class index. If set to NO only the inherited external classes will be listed.

2567
doc/musredit_qt5_dox.cfg Normal file
View File

File diff suppressed because it is too large Load Diff

2567
doc/musredit_qt6_dox.cfg Normal file
View File

File diff suppressed because it is too large Load Diff

22
doc/musrfit.dox
View File

@@ -16,18 +16,18 @@
<p>People merely interested in the handling of the programs should check this link:
\htmlonly
<a href="http://lmu.web.psi.ch/musrfit/user/html/index.html">musrfit user manual</a>
<a href="https://lmu.pages.psi.ch/musrfit-docu/">musrfit user manual</a>
\endhtmlonly
\latexonly
musrfit user manual: \texttt{http://lmu.web.psi.ch/musrfit/user/html/index.html}
musrfit user manual: \texttt{https://lmu.pages.psi.ch/musrfit-docu/user-manual.html}
\endlatexonly
<p>People which would like to know how to install the musrfit framework, please check this link:
\htmlonly
<a href="http://lmu.web.psi.ch/musrfit/user/html/setup-standard.html">How to setup musrfit on different platforms</a>
<a href="https://lmu.pages.psi.ch/musrfit-docu/setup-standard.html">How to setup musrfit on different platforms</a>
\endhtmlonly
\latexonly
How to setup musrfit on different platforms: \texttt{http://lmu.web.psi.ch/musrfit/user/html/setup-standard.html}
How to setup musrfit on different platforms: \texttt{https://lmu.pages.psi.ch/musrfit-docu/setup-standard.html}
\endlatexonly
//****************************************************************************************************
@@ -47,15 +47,13 @@ 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.
- **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.
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. 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 or Qt6.x. 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.
- **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). 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.
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.
- **addRun**: allows to add runs from the command line
- **any2many**: should be a "universal" muSR data-file-format converter.
- **dump_header**: is a small program to dump the header information of a muSR data file to the standard output.
- **musrRootValidation**: this is a program to validate MusrRoot files.
@@ -79,7 +77,11 @@ This two points are somewhat contradictory, and currently it is not clear which
\section bugs How to report bugs
<p>Bugs, unexpected features, can be reported directly to me: \verbatim andreas.suter@psi.ch, \endverbatim or entered in the bug-tracking tool at
bitbkucket \verbatim https://bitbucket.org/muonspin/musrfit/issues \endverbatim.
<p>Bugs, unexpected features, can be reported directly to me: \verbatim andreas.suter@psi.ch, \endverbatim or entered in the bug-tracking tool at \htmlonly
<a href="https://bitbucket.org/muonspin/musrfit/issues">bitbucket issue tracker</a>
\endhtmlonly
\latexonly
\verbatim https://bitbucket.org/muonspin/musrfit/issues \endverbatim.
\endlatexonly
*/

788
doc/musrfit_dox.cfg
View File

File diff suppressed because it is too large Load Diff