Skip to content

Commit

Permalink
merged master, prepare for release 3.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
lcts committed Jun 26, 2017
2 parents c3de435 + ded9ce3 commit d0ca94e
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 24 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
*.m~
resource/
testfiles/
private/machines/*
scconfig.m
6 changes: 4 additions & 2 deletions documentation/CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ v2.0.0
- new configuration file to set defaults
- universal interface for new loading functions
- extended documentation
v2.1.1
v2.0.1
- spincounting now displays the field/frequency values used as bg limits instead of indices
- spincounting now switches to nosave mode if file selection dialog is aborted, after prompting the user
- fixed bug where FitResDip would prompt user for invalid option 'background'
Expand All @@ -55,7 +55,7 @@ v3.0.0
- API CHANGE: output struct reorganised
- CONFIG CHANGE: format of scconfig changed
- CONFIG CHANGE: spincounting now supports per-machine configurations
- REQUIREMENTS: now requires Matlab R213b
- REQUIREMENTS: now requires Matlab R2013b
- existing configurations are no longer overwritten during installation
- q value can now be read from spectrum file as well as input manually/determined from tune pic file
- spincounting now asks for spectrum file first, then tune file. This is necessary for getting q from spectrum
Expand All @@ -65,3 +65,5 @@ v3.0.0
- added support for Magnetec XML files
- added support for saving reults to a .mat-file
- failure to fit the dip in tune file no longer aborts program execution
v3.0.1
- fixed error with config version checks
2 changes: 1 addition & 1 deletion documentation/INSTALL
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
____________________________________________________________
| |
| THE SPINCOUNTING TOOLBOX v3.0.0 |
| THE SPINCOUNTING TOOLBOX v3.0.1 |
| |
| Author: Christopher Engelhard |
| Mail: christopher.engelhard@fu-berlin.de |
Expand Down
2 changes: 1 addition & 1 deletion documentation/README
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
____________________________________________________________
| |
| THE SPINCOUNTING TOOLBOX v3.0.0 |
| THE SPINCOUNTING TOOLBOX v3.0.1 |
| |
| Author: Christopher Engelhard |
| Mail: christopher.engelhard@fu-berlin.de |
Expand Down
3 changes: 3 additions & 0 deletions documentation/templates/scconfig.m.template
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
% 2) Rename it to scconfig.m
% 3) Edit accoding to your needs

% Version of this config file. Do not change unless spincounting tells you to.
CONFIG_VERSION = '3';

% Allow all options to be set in scconfig and machine files, instead of separating them into
% program state/execution options ( scconfig) and evaluation-related parameteres (machine)
% Default: false
Expand Down
42 changes: 23 additions & 19 deletions spincounting.m
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
function [out, strout] = spincounting(varargin)
% SPINCOUNTING - quantitative evaluation of EPR spectra
% spincounting - quantitative evaluation of EPR spectra
%
% USAGE:
% SPINCOUNTING
% out = SPINCOUNTING('tfactor',<value>)
% out = SPINCOUNTING('nspins', <value>)
% [out, strout] = SPINCOUNTING(___, '<option>', <value>)
% [out, strout] = SPINCOUNTING(struct)
% spincounting
% out = spincounting('tfactor',<value>)
% out = spincounting('nspins', <value>)
% [out, strout] = spincounting(___, '<option>', <value>)
% [out, strout] = spincounting(struct)
%
% OPTIONS:
% tunefile : string, tune picture file, default: Prompt
Expand All @@ -15,27 +15,30 @@
% outformat : string, output format for plots, default: 'pdf'
% nosave : boolean, don't save anything if true, default: false
% savemat : boolean, save results to .mat file, default: false
% warn : string, disable most warning, default: 'nochange'
% machine : string, machine file to use, default: unset
% nspins : float, # of spins in sample, default: unset
% tfactor : float, spectrometer transfer factor, default: unset
% nospec : boolean, only determine q, default: false
% noplot : boolean, do not display plots. They are still generated
% and saved, default: false
% warn : string, control warnings. Can be one of 'on', 'off' or
% 'nochange' (default)
% machine : string, name of machine file to load, default: unset
%
% nspins : float, # of spins in sample, default: unset
% tfactor : float, spectrometer transfer factor, default: unset
% q : float, quality factor q. Setting this disables all q-factor
% calculation related functionality, default: unset
% S : float, spin of sample, default: unset
% maxpwr : float, maximum microwave power in W, default: unset
% rgain : float, receiver gain factor, default: unset
% tc : float, time constant in ms, default: unset
% nscans : integer, # of scans, default: unset
% pwr : float, microwave power in mW, default: unset
% pwr : float, microwave power in W, default: unset
% attn : float, attenuation in dB, default: unset
% T : float, temperature in K, default: unset
% modamp : float, modulation amplitude in G, default: unset
% mwfreq : float, microwave frequency in Hz, default: unset
% tunepicscaling : float, scaling of the tune picture in MHz/<x unit>, default: 6,94e4
% when using an image as a tune file, use the tune picture width in MHz
% tunepicscaling : float, scaling of the tune picture in MHz/<x unit>,
% default: unset
% When using an image as a tune file, use the tune picture width in MHz
% instead, as the created x-axis is meaningless for image files
% tunebglimits : 1x4 integer, indices of background, default: auto
% tunepicsmoothing : integer, # of points used for smoothing, default 2.5% of total
Expand All @@ -46,7 +49,10 @@
% determines # of steps, default [1 3]
%
% All options can be given as either Option-Value pairs or in the form of a struct
% with struct.<Option> = <Value>
% with struct.<Option> = <Value>. Both can be used simultaneously, e.g.
%
% [out, strout] = spincounting(struct, '<option>', <value>)
%
%
% OUTPUTS:
% out : depending on the operating mode, returns either the number of spins,
Expand All @@ -60,7 +66,7 @@


%==================================================================================================%
VERSION = '3.0.0';
VERSION = '3.0.1';
RUNDATE = datestr(now);
CV_REQUIRED = '3';

Expand All @@ -83,8 +89,6 @@
'Missing function ''eprload'', which is needed for loading Bruker and Magnetec XML file types. Please install easyspin (www.easyspin.org) if you use those formats.');
end

>>>>>>> master

%% PARSE INPUT ARGUMENTS WITH InputParser
%==================================================================================================%
% define input arguments
Expand Down Expand Up @@ -194,7 +198,7 @@
% check if config file is up-to-date
CV_REQUIRED_NUMERIC = sscanf(CV_REQUIRED,'%d.%d.%d');
if exist('CONFIG_VERSION', 'var') ~= 1
CONFIG_VERSION = [NaN; NaN; NaN];
CONFIG_VERSION = [0; 0; 0];
else
CONFIG_VERSION = sscanf(CONFIG_VERSION,'%d.%d.%d');
CONFIG_VERSION = [CONFIG_VERSION; zeros(3-length(CONFIG_VERSION),1)];
Expand All @@ -205,7 +209,7 @@
warning(['Configuration file must be at least version %s. ', ...
'Please read the section ''Migration from previous versions'' in ', ...
'documentation/INSTALL on how to adapt your configuration and scripts.', ...
'\n\nAfterwards, set ''CONFIG_VERSION = %s'' in scconfig.m to disable this warning.'], ...
'\n\nAfterwards, set ''CONFIG_VERSION = ''%s'''' in scconfig.m to disable this warning.'], ...
CV_REQUIRED, CV_REQUIRED);
return;
end
Expand Down

0 comments on commit d0ca94e

Please sign in to comment.