Skip to content

Commit f0b3a65

Browse files
authored
Updates version to 1.0.0 (#394)
1 parent 88c62f3 commit f0b3a65

File tree

6 files changed

+51
-8
lines changed

6 files changed

+51
-8
lines changed

CITATION.cff

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
abstract: <p><span>The Reflectivity Algorithms Toolbox (RAT) for Rascal is a MATLAB
2+
toolbox for analysing non-polarized neutron reflectivity data. The toolbox is designed
3+
to fit multiple contrast neutron reflectivity data, using the Abeles formalism with
4+
either traditional layer models, or using user-defined custom models.</span></p>
5+
authors:
6+
- affiliation: Science and Technology Facilities Council
7+
family-names: Hughes
8+
given-names: Arwel Vaughan
9+
orcid: 0009-0007-1918-8401
10+
- family-names: Pastula
11+
given-names: Sethu Pavan Venkata Reddy
12+
orcid: 0000-0001-7962-1827
13+
- affiliation: Science and Technology Facilities Council
14+
family-names: Room
15+
given-names: Alex H.
16+
orcid: 0000-0002-5314-2331
17+
- affiliation: Science and Technology Facilities Council
18+
family-names: Farooq
19+
given-names: Rabiya
20+
orcid: 0009-0008-1436-3933
21+
- affiliation: Science and Technology Facilities Council
22+
family-names: Sharp
23+
given-names: Paul
24+
orcid: 0000-0003-3072-6155
25+
- affiliation: Science and Technology Facilities Council
26+
family-names: Nneji
27+
given-names: Stephen
28+
orcid: 0000-0001-9369-1346
29+
cff-version: 1.2.0
30+
date-released: '2025-04-11'
31+
doi: 10.5281/zenodo.15193992
32+
keywords:
33+
- Reflectometry
34+
- Neutron
35+
license:
36+
- gpl-3.0-or-later
37+
message: If you use this software, please cite it using the metadata from this file.
38+
title: Reflectivity Algorithms Toolbox for RasCAL
39+
type: software
40+
version: 1.0.0

CONTRIBUTING.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ The MATLAB IDE is recommended for development, the following toolboxes are requi
1010
- MATLAB Coder
1111
- MATLAB Compiler
1212
- Parallel Computing Toolbox
13-
- Statistics and Machine Learning Toolbox (for DREAM Minimizer)
1413

1514
After installing the IDE, proceed by creating a fork of the RAT repo, then clone the fork
1615

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15193992.svg)](https://doi.org/10.5281/zenodo.15193992)
12
[![license](https://img.shields.io/github/license/RascalSoftware/RAT.svg)](https://github.com/RascalSoftware/RAT/blob/master/LICENSE)
23
[![release](https://img.shields.io/github/release/RascalSoftware/RAT.svg)](https://github.com/RascalSoftware/RAT/releases)
34
[![Unit Tests](https://github.com/RascalSoftware/RAT/actions/workflows/runTests.yml/badge.svg)](https://github.com/RascalSoftware/RAT/actions/workflows/runTests.yml)
45

6+
57
RAT
68
===
7-
RAT is an acronym for Reflectivity Algorithms Toolbox for Rascal. This is a MATLAB toolbox for analysing non-polarized neutron reflectivity data at multiple contrasts. This is designed to fit multiple contrast neutron reflectivity data, primarily using the Abeles layer model but user-defined model function are also supported.
9+
The Reflectivity Algorithms Toolbox (RAT) for Rascal is a MATLAB toolbox for analysing non-polarized neutron reflectivity data. The toolbox is designed to fit multiple contrast neutron reflectivity data, using the Abeles formalism with either traditional layer models, or using user-defined custom models.
810

9-
This is currently still in development. We are working towards a first release of the toolbox. In the meantime, please note that usage may change and that releases are not yet stable.
11+
How to Use
12+
----------
13+
MATLAB is required to RAT, the minimum supported version is **R2023a**. To use RAT, download and extract the appropriate version for you OS from the [release](https://github.com/RascalSoftware/RAT/releases) page. In the extracted folder, run the `addPaths` script in the MATLAB console and you can now run your analysis.
260 Bytes
Binary file not shown.

utilities/plotting/plotHists.m

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
function h = plotHists(result, options)
1+
function plotHists(result, options)
22
% Plots the Bayes histogram plot from the chain, with or without smoothing.
33
% If selected, smoothing is via a moving average algorithm.
44
%
@@ -28,7 +28,7 @@
2828
smooth = options.smooth;
2929

3030
if ~isempty(options.figure)
31-
h = figure(options.figure);
31+
h = figure(options.figure);
3232
else
3333
h = figure();
3434
end
@@ -53,9 +53,9 @@
5353
N = smoothdata(N, 'movmean');
5454
end
5555

56-
bar(edges2,N,1,'w')
56+
bar(edges2,N,1,'w');
5757

5858
set(h,'ytick',[]);
59-
title(sprintf('%s',fitNames{i}))
59+
title(sprintf('%s',fitNames{i}));
6060
end
6161
end

version.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.0.0-beta
1+
1.0.0

0 commit comments

Comments
 (0)