Skip to content

Commit

Permalink
Updated README to rst and removed erroneous file
Browse files Browse the repository at this point in the history
* removed extra file

* updated README to .rst, added badges for coveralls and appveyor

* updated badges

* removed target from badges

* and now on one line...

* more badge stuff
  • Loading branch information
arcondello committed Oct 11, 2017
1 parent 981f2cb commit c14ef18
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 63 deletions.
28 changes: 22 additions & 6 deletions README.md → README.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
# dimod
dimod
=====

[![Build Status](https://travis-ci.org/dwavesystems/dimod.svg?branch=master)](https://travis-ci.org/dwavesystems/dimod)
.. image:: https://travis-ci.org/dwavesystems/dimod.svg?branch=master
:target: https://travis-ci.org/dwavesystems/dimod

.. image:: https://ci.appveyor.com/api/projects/status/kfhg35q12fa0lux8?svg=true
:target: https://ci.appveyor.com/project/arcondello/dimod

.. image:: https://coveralls.io/repos/github/dwavesystems/dimod/badge.svg?branch=master
:target: https://coveralls.io/github/dwavesystems/dimod?branch=master

A shared API for QUBO/Ising samplers.

## Included Samplers
Included Samplers
-----------------

dimod comes with a few samplers that are useful as reference implementations and for unit testing.

* SimulatedAnnealingSampler: A reference implementation of a simulated annealing algorithm.
* ExactSolver: determines the energy for every possible sample, but is extremely slow.
* RandomSampler: Generates random samples. Used for testing.

## Basic Usage
Basic Usage
-----------

```python
>>> import dimod
Expand All @@ -39,17 +49,23 @@ The response object returned has many ways to access the information

See documentation for more examples.

## Install
Install
-------

Compatible with Python 2 and 3.

`pip install dimod`

To install with optional components

`pip install dimod[all]`

To install from source:

`python setup.py install`

## License
License
-------

Released under the Apache License 2.0. See LICENSE.txt

57 changes: 0 additions & 57 deletions dimod/composite_template.py

This file was deleted.

0 comments on commit c14ef18

Please sign in to comment.