---
# System prepended metadata

title: Dice README

---

# Dice README

![](https://i.imgur.com/PPTap3v.png)

---

### **About**
***Dice*** is a hybrid Fortran/Python code for running Variational Quantum Monte Carlo (VQMC) simulations. It is capable of determining the ground state energy and wave functions of the following systems: the quantum harmonic oscillator, the hydrogen ion and the hydrogen molecule. This was achieved with a high-performance parallel backend code, written in Fortran and a Python frontend for input generation and results visualisation. The software release date is on Thursday 27th May 2021.

The following links can be used to get around important websites relating to ***Dice***, including the developer documentation. The latest version of the [User Manual](https://github.com/HetSys/PX915_2021_A/files/6550470/PX915_User_Manual.pdf) is available in the repository, under _MANUAL.pdf_. To learn how to use ***Dice***, check out the Jupyter notebook tutorial in _Tutorial.ipynb_.

| Destination | Link |
| ----------- | ---- |
| GitHub | [Here](https://github.com/HetSys/PX915_2021_A) |
| Dev Documentation Main | [Here](https://joegilkes.github.io/PX915-Docs/) |
| Fortran Dev Documentation | [Here](https://joegilkes.github.io/PX915-Docs/fortran/docs/index.html) |
| Python Dev Documentation | [Here](https://joegilkes.github.io/PX915-Docs/python/docs/index.html) |


---


### **Keywords**

***Variational Quantum Monte Carlo***, ***Quantum Harmonic Oscillator***, ***Hydrogen Atom***, ***Hydrogen Ion***, ***Hydrogen Molecule***, ***Parallel Computing***, ***Fortran***, ***Python***


---

### **Build Instructions**

***Dice*** has a complex set of dependencies for both the Fortran backend and the Python frontend. These are listed in the User Manual, alongside instructions for their installation on the Warwick SCRTP system.

Compiling ***Dice*** requires specifying your compiler in the Makefile, and then it's as simple as running `make`. Again, full instructions are given in the User Manual.


---

### **FAQ**

***Q: Is a PDF version of the developer documentation available?***

*A: There will not be any PDF version of the developer documentation. It is extremely detailed and would be cumbersome to read linearly as PDF files. This is why we are hosting the developer documentation as HTML files to help users to navigate through the contents much quicker.*

***Q: What could I do if I spot a bug in the software?***

*A: If you find a bug in **Dice**, please notify the developers (anyone in the **contributor** table) by raising it as an issue in the **Issues** tab in the relevant branch of the **Dice** GitHub repository. Key bug fixes will be documented in a changelog in the next stable version release.*


---

### **Further Documentation**

#### **Design Document**
The [Design Document](https://github.com/HetSys/PX915_2021_A/files/6542663/PX915_Design_Document.pdf) for ***Dice*** explains the following topics in details:
* Code Structure
* Algorithms
* Parallelism methods
* Error Handling
* Documentation
* Collaboration mechanisms

#### **Software Specification**
The [Software Specification](https://github.com/HetSys/PX915_2021_A/files/6542668/PX915_Software_Specification.pdf) document will discuss ***Dice***'s' *Performance*, *Input*, *Output*, *Engine*, *Analysis* and *Extensions* in details. 

#### **Work Plan**
The initial work plan for ***Dice*** can be found in details in [Work Plan Explanation](https://github.com/HetSys/PX915_2021_A/files/6542671/PX915_Workplan_Explanation.pdf). This document has shown a clear division of labour during the five weeks that Group A will have to work on the project. 


---
