Skip to content

Commit ac57c84

Browse files
committed
Changing readme to markdown and updating.
1 parent 8f52050 commit ac57c84

File tree

2 files changed

+40
-22
lines changed

2 files changed

+40
-22
lines changed

README

-22
This file was deleted.

README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Diagonalisation of Quantum Observables (DoQO)
2+
3+
DoQO is a code for diagonalising obervables for quantum lattice models. It is
4+
written in C/C++ and makes use of the SLEPc and PETSc libraries to run on
5+
massively parallel distributed memory cluster. The code has been published along
6+
with an accompanying paper in the journal of computer physics communications at
7+
[http://www.sciencedirect.com/science/article/pii/S0010465511000099](http://www.sciencedirect.com/science/article/pii/S0010465511000099).
8+
9+
## To build DoQO.
10+
11+
1. Ensure petsc and slepc are installed.
12+
13+
2. Create build folder.
14+
```
15+
mkdir build
16+
```
17+
18+
3. Run cmake to create makefiles. Specify boost location if not found automatically.
19+
```
20+
cd build
21+
cmake ../
22+
```
23+
or
24+
```
25+
cmake ../ -DBOOST_ROOT=<boost_path>
26+
```
27+
One can also specify an install prefix by setting the CMAKE_INSTALL_PREFIX variable with `-DCMAKE_INSTALL_PREFIX=<path>`
28+
29+
Not if one gets an error about "unset" from FindBoost, this is a cache issue, delete the build directory and start again.
30+
31+
4. Once cmake completes successfully build using.
32+
```
33+
make
34+
```
35+
36+
5. Install binaries using
37+
```
38+
make install
39+
```
40+

0 commit comments

Comments
 (0)