Metadata-Version: 2.0
Name: qnet-qsd
Version: 0.1.0
Summary: A code-converter and simulation driver between QNET and QSD
Home-page: https://github.com/mabuchilab/qnet_qsd
Author: Michael Goerz
Author-email: mail@michaelgoerz.net
License: MIT license
Keywords: qnet_qsd
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: dev
Requires-Dist: sympy
Requires-Dist: qnet (==2.0.0-dev)
Requires-Dist: trajectorydata
Provides-Extra: dev
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-xdist; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Requires-Dist: pep8; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: wheel; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: sphinx-autobuild; extra == 'dev'
Requires-Dist: sphinx-rtd-theme; extra == 'dev'
Requires-Dist: better-apidoc; extra == 'dev'

========
QNET-QSD
========
.. image:: https://img.shields.io/pypi/v/qnet_qsd.svg
        :target: https://pypi.python.org/pypi/qnet_qsd

.. image:: https://img.shields.io/travis/mabuchilab/qnet_qsd.svg
        :target: https://travis-ci.org/mabuchilab/qnet_qsd
.. image:: https://coveralls.io/repos/github/mabuchilab/qnet_qsd/badge.svg?branch=master
        :target: https://coveralls.io/github/mabuchilab/qnet_qsd?branch=master
.. image:: https://readthedocs.org/projects/qnet-qsd/badge/?version=latest
        :target: https://qnet-qsd.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

A code-converter and simulation driver between QNET and QSD

Development of QNET-QSD happens on `Github`_.


Installation
------------
To install the latest released version of QNET-QSD, run this command in your terminal:

.. code-block:: console

    $ pip install qnet_qsd

This is the preferred method to install QNET-QSD, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


To install the latest development version of QNET-QSD from the from the `Github`_.

.. code-block:: console

    $ pip install git+https://github.com/mabuchilab/qnet_qsd.git@master#egg=qnet_qsd

.. _Github: https://github.com/mabuchilab/qnet_qsd

Usage
-----

To use QNET-QSD in a project::

    import qnet_qsd


=======
History
=======

0.1.0 (2018-03-31)
------------------

* Initial release


