Skip to content

Commit

Permalink
Regenerate docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
catch22 committed Feb 14, 2017
1 parent a884696 commit 9523e03
Show file tree
Hide file tree
Showing 34 changed files with 11,880 additions and 541 deletions.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: b0dbc530dce8d2cd74081235b96ed9c4
config: 43e0a6491dd7c0f731f6416ecab5689a
tags: 645f666f9bcd5a90fca523b33c5a78b7
3 changes: 3 additions & 0 deletions docs/_build/html/_sources/changes.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. currentmodule:: moment_polytopes

.. include:: ../CHANGES
57 changes: 57 additions & 0 deletions docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
.. title:: moment_polytopes

Welcome!
========

This is a `SageMath <http://www.sagemath.org>`_ package for computing moment polytopes associated with finite-dimensional representations of compact and connected Lie groups, based on the algorithm proposed by `Vergne and Walter (2014) <https://arxiv.org/abs/1410.8144>`_ (see also `Walter (2014) <https://arxiv.org/abs/1410.6820>`_ for further detail).


Introduction
------------

The following code solves the one-body quantum marginal problem for three qubits:

.. literalinclude:: ../examples/three_qubits.py
:language: python

You can install the latest version of this package as follows:

.. code-block:: bash
sage -i lrslib
sage -pip install git+git://github.com/catch22/moment_polytopes --upgrade
Now download the :download:`three_qubits.py <../examples/three_qubits.py>` example and run it via ``sage three_qubits.py``.
See :doc:`installation` for further detail and troubleshooting.

We have used this package to compute moment polytopes associated with various :doc:`qmp`.


Documentation
-------------

.. toctree::
:maxdepth: 2

installation
qmp
reference
changes
license


Citation
--------

If you use this software, please consider citing our article:

.. code-block:: bibtex
@article{moment_polytopes,
author = {Vergne, M. and Walter, M.},
title = {Inequalities for moment cones of finite-dimensional representations},
year = {2014},
journal = {to appear in Journal of Symplectic Geometry},
eprint = {1410.8144},
note = {Software available at \url{https://catch22.github.io/moment_polytopes/}.},
}
34 changes: 34 additions & 0 deletions docs/_build/html/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Installation
============

This package requires `SageMath <http://www.sagemath.org>`_ 7.5 or higher. It can be installed as follows:

.. code-block:: bash
sage -i lrslib
sage -pip install git+git://github.com/catch22/moment_polytopes
To test your installation, download the :download:`three_qubits.py <../examples/three_qubits.py>` example and run it as follows:

.. code-block:: bash
sage three_qubits.py
Troubleshooting
---------------

If on the second line you get an error message saying that "pip is configured with locations that require TLS/SSL, however the ssl module in Python is not available", please run the following and retry:

.. code-block:: bash
sage -i openssl
sage -f python2
Mathematica Integration
-----------------------

`Wolfram Mathematica <https://www.wolfram.com/mathematica/>`_ contains some clever heuristics for evaluating determinants of polynomial matrices, and we provide the ``mathematica`` algorithm in :func:`moment_polytopes.ressayre_tester` etc. to leverage its functionality.

To use it, Mathematica needs to be installed and the ``math`` executable has to be available in the current ``PATH``. Run ``print mathematica._install_hints()`` at the ``sage`` prompt for further information on how to set up SageMath's Mathematica integration.
4 changes: 4 additions & 0 deletions docs/_build/html/_sources/license.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
License
=======

.. include:: ../LICENSE
Loading

0 comments on commit 9523e03

Please sign in to comment.