Permalink
Browse files

Paper link (#81)

* updated citation

* updated readme
  • Loading branch information...
babbush committed Oct 23, 2017
1 parent 0233d10 commit bae97f3a6bd862474d1ea04e94bedc5f5008c181
Showing with 5 additions and 32 deletions.
  1. +3 −3 README.rst
  2. +2 −29 docker/README.md
View
@@ -114,8 +114,8 @@ Authors
`Yudong Cao <https://github.com/yudongcao>`__ (Harvard),
`E. Schuyler Fried <https://github.com/schuylerfried>`__ (Harvard),
`Craig Gidney <https://github.com/Strilanc>`__ (Google),
`Thomas Haener <https://github.com/thomashaener>`__ (ETH Zurich),
`Vojtech Havlicek <https://github.com/VojtaHavlicek>`__ (Oxford),
`Thomas Häner <https://github.com/thomashaener>`__ (ETH Zurich),
`Vojtĕch Havlíček <https://github.com/VojtaHavlicek>`__ (Oxford),
`Zhang Jiang <https://ti.arc.nasa.gov/profile/zjiang3>`__ (NASA),
`Matthew Neeley <https://github.com/maffoo>`__ (Google),
`Jhonathan Romero <https://github.com/jromerofontalvo>`__ (Harvard),
@@ -137,7 +137,7 @@ When using OpenFermion for research projects, please cite:
Zhang Jiang, Matthew Neeley, Jhonathan Romero, Nicholas Rubin, Nicolas P. D.
Sawaya, Kanav Setia, Sukin Sim, Wei Sun, Kevin Sung and Ryan Babbush.
*OpenFermion: The Electronic Structure Package for Quantum Computers*.
arXiv preprint. 2017.
`arXiv:1710.07629 <https://arxiv.org/abs/1710.07629>`__. 2017.
We are happy to include future contributors as authors on later releases.
View
@@ -25,42 +25,15 @@ OpenFermion (or any of its plugins) using the standard installation.
## Setting up Docker for the first time
You first need to install [Docker](https://www.docker.com/).
Once Docker is installed, open a command line terminal and check the list
of running virtual machines with `docker-machine ls`.
Assuming this is the first time Docker has been run, the list should be empty.
Create a virtual machine by running:
```
docker-machine create --driver virtualbox default
```
To be able to run this, one needs to install
[VirtualBox](https://www.virtualbox.org/wiki/Downloads).
Here, "default" is just the name of the virtual machine. You can replace it by
any name that you prefer. To check that the virtual machine is indeed running,
use `docker-machine ls` again.
After the Docker virtual machine is created, configure the shell by running
```
docker-machine env default
```
where if you named the virtual machine differently from default you should also
replace "default" with the customized name. The command above will return an OS
dependent message containing the command to run for configuring the shell;
follow those instructions.
## Running OpenFermion with Docker
Now that Docker is set up, one can navigate to the folder containing the
Once Docker is setup, one can navigate to the folder containing the
Dockerfile for building the OpenFermion image (docker/dockerfile) and run
```
docker build -t openfermion_docker .
```
where "openfermion_docker" is just an arbitrary name for our docker image.
What the Dockerfile does is to start from a base image of Ubuntu and install
Building the Dockerfile starts from a base image of Ubuntu and then installs
OpenFermion, its plugins, and the necessary applications needed for running these
programs. This is a fairly involved setup and will take some time
(perhaps up to thiry minutes depending on the computer). Once installation has

0 comments on commit bae97f3

Please sign in to comment.