From 39f739e2c851b4aed3af5d4f30d4e8a33198328f Mon Sep 17 00:00:00 2001 From: Andreas Suter Date: Sat, 21 Feb 2015 14:43:50 +0100 Subject: [PATCH] added vanilla README for automake --- README | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 00000000..9c6eabfc --- /dev/null +++ b/README @@ -0,0 +1,35 @@ +README + +musrfit - muSR data analysis package + +Contents +-------- + +This is a data analysis package to analyze time differential muSR and beta-NMR data. +Currently it allows the following things: + +* setting up most commonly used fitting functions for muSR and beta-NMR +* fitting data, including global fits +* showing the fit results and the residuals +* showing the Fourier transform of the data +* extracting easily the fitting parameters to be used in other programs (gnuplot, qtiplot/origin, ...) +* allows to generate fitting input files for follow-up runs +* allows to generate global fitting input files based on a single run template +* allows to implement more sophisticated user functions + (e.g. GL vortex lattice, Meissner screening including low-energy muon stopping profiles) + +Currently supported platforms: + +* Linux +* Mac OS X +* Windows - not really, only for the very brave ones + +Documentation + +For a more exhaustive user documentation see: + + http://lmu.web.psi.ch/musrfit/user/MUSR/WebHome.html + +Contact + +