Skip to content

Fixes README typos and add docs link #395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StephenNneji merged 1 commit into from
Apr 11, 2025
Merged

Fixes README typos and add docs link #395

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ RAT
===
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.

How to Use
----------
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.
The RAT documentation is available online [here](https://rascalsoftware.github.io/RAT-Docs/dev/index.html).

Installation
------------
MATLAB is required to use RAT; the minimum supported version is **R2023a**. To use RAT, download and extract the appropriate version for your 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.
Loading