File	Date	Author	Commit
deploy	2013-09-06	Ulf Lorenz	[8659fb] Cleanup: centralized the Makefile
include	2013-09-12	Ulf Lorenz	[de140e] Added FFT to the grid; With this, release 0.0.1...
src	2013-09-12	Ulf Lorenz	[de140e] Added FFT to the grid; With this, release 0.0.1...
test	2013-09-09	Ulf Lorenz	[f2aafb] used FFT inside kinetic energy operator
GPL.txt	2013-03-22	Ulf Lorenz	[9f157e] added license files
LICENSE	2013-03-22	Ulf Lorenz	[9f157e] added license files
Makefile	2013-09-06	Ulf Lorenz	[8659fb] Cleanup: centralized the Makefile
Makefile.files	2013-09-06	Ulf Lorenz	[8659fb] Cleanup: centralized the Makefile
Makefile.rules.template	2013-09-07	Ulf Lorenz	[9186fa] updated the README and the Makefile.rules to si...
README	2013-09-07	Ulf Lorenz	[9186fa] updated the README and the Makefile.rules to si...

Read Me

Description
===========

This is (or will become) a C++ library to numerically solve the Schroedinger
equation for distinguishable particles.

The code is under the GNU General Public License; see the accompagnying license
file for the lawyer text.

As of now, the code is rather rudimentary; you can solve the Schroedinger
equation for a one-dimensional free particle or similarly primitive problem,
and that is it; however, we naturally plan to extend this in the nearer future.


System requirements
===================

To be able to compile the code at all, you need the following:

* a compiler that implements the latest C++-11 standard.
  One of the later g++ (around version 4.7) or CLang++ version 3.2 should be fine.
* the tensor library that we use
  - clone it via git from https://github.com/juanjosegarciaripoll/tensor.git
  - compile and install it (usual autoconf setup)
  - note that you will need to enable FFTW support (thus, you also need the FFTW libraries)
* The boost libraries from http://www.boost.org
  - I _think_ boost 1.49 (stone old) should be fine, since you need a separate
    copy of odeint anyway.
* The odeint library; although this is part of boost, we use some features that
  will only become available in boost 1.55 or 1.56, so you need a separate copy.
  - get it from via git from https://github.com/headmyshoulder/odeint-v2.git
  - add the include path to the CXXFLAGS in Makefile.rules (see next section)
* googletest for compiling the tests (tested with 1.6.0) 
  - get it from http://code.google.com/p/googletest/
  - set GTEST_DIR in Makefile.rules (see next section)


Compilation
===========

To compile the code, copy the file "Makefile.rules.template" to Makefile.rules,
modify the settings in there, and type "make".
This will build the code and all tests, and run all tests.