Commit d1d73470 authored by Ben Hazelwood's avatar Ben Hazelwood
Browse files

Update readme

parent 36965505
......@@ -4,20 +4,15 @@
This wrapper adds functionality to MPI enabling replication and team based execution.
### How do I get set up? ###
TODO
* Summary of set up
* Configuration
* Dependencies
* Database configuration
* How to run tests
* Deployment instructions
The library re-defines the weak symbols declared by MPI. This means the replication is transparent to the application.
Unlike other similar libraries, the replicas are free to proceed completely asynchronously from other replicas. They communicate progress and error information via a "heartbeat". A heartbeat is inserted into user via an MPI_Sendrecv(...,MPI_COMM_SELF) call. At each heartbeat, the replicas mark this point on a timeline and compare there progress against the other replicas. If a buffer is provided to the heartbeat then the hashcode is also compared with the other replicas.
### Contribution guidelines ###
TODO
* Writing tests
* Code review
* Other guidelines
### How do I get set up? ###
* Run make in the lib directory
* Optional: rum make in the applications/tests directory
* Link with -ltmpi -L<path to tmpi>
* Add <path to tmpi> to LD_LIBRARY_PATH
### Who do I talk to? ###
Repo owner: Benjamin Hazelwood
\ No newline at end of file
Ben Hazelwood (benjamin.hazelwood@durham.ac.uk)
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment