Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lettis committed Feb 9, 2016
1 parent 2e802b0 commit 1c3a3b9
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,40 +9,38 @@ The project includes the 'xdrfile' library of GROMACS. Thus, you can
use data files written as ASCII data as well as .xtc-trajectories.

For bug-reports, write to

sittel@lettis.net
or
florian.sittel@physik.uni-freiburg.de

Happy Computing.

# Licensing #
The code is published "AS IS" under the simplified BSD license.
For details, please see LICENSE.txt

If you use the code for published works, please cite as

"Florian Sittel (2016), FastPCA - fast Principal Component Analysis Package, http://lettis.github.io/FastPCA"


# Compilation #

Create a build-directory in the project root and change into
that directory:

# mkdir build

# cd build

# mkdir build
# cd build
Run cmake, based on the underlying project:

# cmake ..

# cmake ..
Hopefully, everything went right.
If not, carefully read the error messages.
Typical errors are missing dependencies...

If everything is o.k., run make (on multicore machines, use '-j' to parallelize
compilation, e.g. 'make -j 4' for up to four parallel jobs):

# make

# make
Now, you should find the 'fastca' binary in the 'src' folder.


## Requirements ##
* LAPACK
* Boost (program_options), min. version 1.49
Expand Down

0 comments on commit 1c3a3b9

Please sign in to comment.