Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added minimal REQUIREMENTS, INSTALLATION, and USAGE sections and a reference to the COPYING file containing licensing info.
  • Loading branch information
quintquant authored Nov 10, 2020
1 parent 14582b6 commit a68c78b
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,32 @@

Software to carry out Principal Component Analysis (PCA) of experimental (or simulated) data.

This software was originally developed by Jorge Quintanilla as part of a collaboration involving Stuart Gibson, Robert Twyman, Gunnar Moller and Tymoteusz Tula, all at the University of Kent.
This software was originally developed by Jorge Quintanilla as part of a collaboration involving Stuart Gibson, Robert Twyman, Gunnar Moller and Tymoteusz Tula, all at the University of Kent. For licensing information, see COPYING.

This software is optimised for Octave but can be easily adapted for use with Matlab.

REQUIREMENTS

A working installation of Octave (the software has been tested on Octave 3.4.3; the source code has comments explaining how it can be adapted for use on Matlab).

INSTALLATION

No installation required - just place the file functions_PCA_current.m in your working directory.

USAGE

Start Octave.

Type the command

source "functions_PCA_current.m"

This will make available the following Octave functions:

PCA
gen_A
gen_image_matrix
recons
scores

The usage of each of these functions is documented thorugh comments within its source code.

0 comments on commit a68c78b

Please sign in to comment.