index.rst 4.61 KB
Newer Older
1
.. picos documentation master file, created by
bzfsagno's avatar
bzfsagno committed
2 3 4 5
   sphinx-quickstart on Thu Mar  1 10:03:01 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

bzfsagno's avatar
bzfsagno committed
6 7 8 9
.. |br| raw:: html

   <br />

bzfsagno's avatar
bzfsagno committed
10 11
PICOS: A Python Interface for Conic Optimization Solvers
========================================================
bzfsagno's avatar
bzfsagno committed
12

13 14
.. image:: _static/picos_big_trans.gif

15 16 17 18
Welcome to the documentation of PICOS,
a user-friendly python interface to many linear and conic optimization solvers,
see more about PICOS in the :ref:`introduction <intro>`.

19 20
The latest version can be downloaded :ref:`here <download>`,
and can be installed by following :ref:`these instructions <requirements>`.
Guillaume Sagnol's avatar
Guillaume Sagnol committed
21 22
Alternatively, you can clone the latest development version from **github**:
``$ git clone https://github.com/gsagnol/picos.git``.
23

24
This documentation contains a :ref:`tutorial <tuto>` and some :ref:`examples <examples>`,
Guillaume Sagnol's avatar
Guillaume Sagnol committed
25 26 27
which should already be enough for a quick start with PICOS.
There is also a :ref:`summary <summary>` of useful implemented functions.
To go deeper,
28 29 30
have a look at the :ref:`picos reference <api>`, which provides information
on every function of PICOS.

bzfsagno's avatar
bzfsagno committed
31

bzfsagno's avatar
bzfsagno committed
32 33
**News**

Guillaume Sagnol's avatar
Guillaume Sagnol committed
34
 * 15 Apr. 15: **Picos** :ref:`1.1.0 <download>` **Released**
Guillaume Sagnol's avatar
Guillaume Sagnol committed
35
    * PICOS is now compatible with **python 3+** (and remains compatible with python 2.6+). Many thanks to `Sergio Callegari <http://www.unibo.it/faculty/sergio.callegari>`_ for this compatibility layer ! If you plan to work with PICOS and python3, think to install the most recent version of your solver (Mosek, Cplex, Gurobi, or Cvxopt). SCIP is not supported in python3+ at this point (but remains supported with python 2.x).
Guillaume Sagnol's avatar
Guillaume Sagnol committed
36
    
Guillaume Sagnol's avatar
Guillaume Sagnol committed
37
    * PICOS is now available on `github <http://github.com/gsagnol/picos>`_.
Guillaume Sagnol's avatar
Guillaume Sagnol committed
38 39
    

Guillaume Sagnol's avatar
Guillaume Sagnol committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53
 * 30 Jan. 15: **Picos** :ref:`1.0.2 <download>` **Released**
    Major release with following new functionalities:
     * Support (read and write) for ``.cbf`` problem files (`conic benchmark format <http://cblib.zib.de/>`_ ), which should be the standard for (mixed integer) conic optimization problems, cf. :func:`write_to_file <picos.Problem.write_to_file>` and :func:`import_cbf <picos.tools.import_cbf>` . 
     * Improved support for complex SDP (more efficient implementation of :func:`to_real() <picos.Problem.to_real>` , corrected bug in the implementation of the scalar product for Hermitian matrices and the conjugate of a complex expression, support for equality constraints involving complex coefficients)
     * Support for inequalities involving the sum of k largest elements of an affine expression, or the k largest eigenvalues of a symmetric matrix expression, cf. the functions :func:`sum_k_largest() <picos.tools.sum_k_largest>` , :func:`sum_k_smallest() <picos.tools.sum_k_smallest>` , :func:`sum_k_largest_lambda() <picos.tools.sum_k_largest_lambda>`, :func:`sum_k_smallest_lambda() <picos.tools.sum_k_smallest_lambda>`, :func:`lambda_max() <picos.tools.lambda_max>` and :func:`lambda_min() <picos.tools.lambda_min>` .
     * Support for inequalities involving the :math:`L_{p,q}-` norm of an affine expresison, cf. :func:`norm() <picos.tools.norm>` .
     * New ``vtype`` for antisymmetric matrix variables ( :attr:`vtype <picos.Variable.vtype>` ``= antisym``).
     * Constraints can be specified as membership in a :class:`Set <picos.Set>` . Sets can be created by the functions :func:`ball() <picos.tools.ball>` , :func:`simplex() <picos.tools.simplex>`, and :func:`truncated_simplex() <picos.tools.truncated_simplex>` .
     * New functions :func:`maximize <picos.Problem.maximize>` and :func:`maximize <picos.Problem.minimize>` to specify the objective function of a problem and solve it. 

    And many thanks to `Petter Wittek <http://peterwittek.com/>`_ for the following improvements, who were motivated by the use of PICOS in the package `ncpol2sdpa <http://peterwittek.github.io/ncpol2sdpa/>`_ for optimization over noncommutative polynomials:
     * More efficient implementation of the writer to the sparse - SDPA file format (:func:`write_to_file <picos.Problem.write_to_file>`)
     * Hadamard (elementwise) product of affine expression is implemented, as an overload of the ``^`` operator,   cf. an example :ref:`here <overloads>` .
     * Partial transposition of an Affine Expression, cf. :func:`partial_transpose() <picos.tools.partial_transpose>` or the :attr:`Tx <picos.AffinExp.Tx>` attribute.
bzfsagno's avatar
bzfsagno committed
54
     
bzfsagno's avatar
bzfsagno committed
55
 * Former changes are listed :ref:`here <changes>`.
bzfsagno's avatar
bzfsagno committed
56

57
.. _contents:
bzfsagno's avatar
bzfsagno committed
58

bzfsagno's avatar
bzfsagno committed
59
**PICOS Documentation contents**
bzfsagno's avatar
bzfsagno committed
60 61

.. toctree::
bzfsagno's avatar
bzfsagno committed
62
   :maxdepth: 2
bzfsagno's avatar
bzfsagno committed
63

bzfsagno's avatar
bzfsagno committed
64
   intro
65
   tuto_summary
66 67
   examples
   api
bzfsagno's avatar
bzfsagno committed
68
   download
bzfsagno's avatar
bzfsagno committed
69
   changes
bzfsagno's avatar
bzfsagno committed
70
   
bzfsagno's avatar
bzfsagno committed
71 72 73 74 75 76 77
Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`