Commit 5385a385 authored by Guillaume Sagnol's avatar Guillaume Sagnol

doc++

parent e75f582b
...@@ -89,4 +89,9 @@ v 1.0.2, 30.01.15: ...@@ -89,4 +89,9 @@ v 1.0.2, 30.01.15:
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: 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>`) * 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>` . * 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. * Partial transposition of an Affine Expression, cf. :func:`partial_transpose() <picos.tools.partial_transpose>` or the :attr:`Tx <picos.AffinExp.Tx>` attribute.
\ No newline at end of file
v 1.1.0, 15.04.15:
* 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).
* PICOS is now available on `github <http://github.com/gsagnol/picos>`_.
\ No newline at end of file
PICOS is a user friendly interface PICOS is a user friendly interface
to several conic and integer programming solvers, to several conic and integer programming solvers,
very much like `YALMIP <http://users.isy.liu.se/johanl/yalmip/>`_ under very much like `YALMIP <http://users.isy.liu.se/johanl/yalmip/>`_
`MATLAB <http://www.mathworks.com/>`_. or `CVX <http://cvxr.com/cvx/>`_ under `MATLAB <http://www.mathworks.com/>`_.
The main motivation for PICOS is to have the possibility to The main motivation for PICOS is to have the possibility to
enter an optimization problem as a *high level model*, enter an optimization problem as a *high level model*,
...@@ -18,14 +18,40 @@ construct a list of constraints by using python list comprehensions, ...@@ -18,14 +18,40 @@ construct a list of constraints by using python list comprehensions,
take slices of multidimensional variables, etc. take slices of multidimensional variables, etc.
Author
======
Picos initial author and current primary developer is:
`Guillaume Sagnol <http://www.zib.de/sagnol>`_, <sagnol( a t )zib.de>
Contributors Contributors
============ ============
People who actively contributed to the code of Picos (in no particular order)
* `Sergio Callegari <http://www.unibo.it/faculty/sergio.callegari>`_
`Guillaume Sagnol <http://www.zib.de/sagnol>`_ * `Petter Wittek <http://peterwittek.com/>`_
* Paul Fournel
* Arno Ulbricht
* Bertrand Omont
Thanks also to Thanks also to
============== ==============
Bertrand Omont People who contributed to the improvement of Picos by sending
their comments, ideas, questions, ... (in no particular order):
* `Dan Stahlke <http://www.stahlke.org/>`_
* `Marco Dalai <http://www.ing.unibs.it/~marco.dalai/>`_
`Elmar Swarat <http://www.zib.de/swarat>`_ * `Matteo Seminaroti <http://www.cwi.nl/people/2683/>`_
* `Warren Schudy <http://cs.brown.edu/~ws/>`_
* `Elmar Swarat <http://www.zib.de/swarat>`_
...@@ -12,4 +12,10 @@ rsync -luzvr full_html/* opts1.zib.de:/www/Abt-Optimization/picos ...@@ -12,4 +12,10 @@ rsync -luzvr full_html/* opts1.zib.de:/www/Abt-Optimization/picos
Register on pypi (python setup.py register, username guillaume.sagnol) Register on pypi (python setup.py register, username guillaume.sagnol)
sed -i 's/Picos 0\.1\.0/Picos 0\.1\.1/g' picos/*.py sed -i 's/Picos 0\.1\.0/Picos 0\.1\.1/g' picos/*.py
et change version num dans conf.py and setup.py and __init__.py et change version num dans conf.py and setup.py and __init__.py
make new directory in the full_html directory and update the symolic link "last" with the ".." trick make new directory in the full_html directory and update the symolic link "last" with the ".." trick
\ No newline at end of file
#git clone https://github.com/gsagnol/picos.git (to clone)
merge master into master_github:
commit and push on master_github:
git push github master_github
...@@ -184,9 +184,13 @@ ...@@ -184,9 +184,13 @@
a user-friendly python interface to many linear and conic optimization solvers, a user-friendly python interface to many linear and conic optimization solvers,
see more about PICOS in the <a class="reference internal" href="intro.html#intro"><em>introduction</em></a>.</p> see more about PICOS in the <a class="reference internal" href="intro.html#intro"><em>introduction</em></a>.</p>
<p>The latest version can be downloaded <a class="reference internal" href="download.html#download"><em>here</em></a>, <p>The latest version can be downloaded <a class="reference internal" href="download.html#download"><em>here</em></a>,
and can be installed by following <a class="reference internal" href="intro.html#requirements"><em>these instructions</em></a>.</p> and can be installed by following <a class="reference internal" href="intro.html#requirements"><em>these instructions</em></a>.
Alternatively, you can clone the latest development version from <strong>github</strong>:
<tt class="docutils literal"><span class="pre">$</span> <span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/gsagnol/picos.git</span></tt>.</p>
<p>This documentation contains a <a class="reference internal" href="tuto_summary.html#tuto"><em>tutorial</em></a> and some <a class="reference internal" href="examples.html#examples"><em>examples</em></a>, <p>This documentation contains a <a class="reference internal" href="tuto_summary.html#tuto"><em>tutorial</em></a> and some <a class="reference internal" href="examples.html#examples"><em>examples</em></a>,
which should already be enough for a quick start with PICOS. To go deeper, which should already be enough for a quick start with PICOS.
There is also a <a class="reference internal" href="summary.html#summary"><em>summary</em></a> of useful implemented functions.
To go deeper,
have a look at the <a class="reference internal" href="api.html#api"><em>picos reference</em></a>, which provides information have a look at the <a class="reference internal" href="api.html#api"><em>picos reference</em></a>, which provides information
on every function of PICOS.</p> on every function of PICOS.</p>
<p><strong>News</strong></p> <p><strong>News</strong></p>
...@@ -195,8 +199,8 @@ on every function of PICOS.</p> ...@@ -195,8 +199,8 @@ on every function of PICOS.</p>
<li><dl class="first docutils"> <li><dl class="first docutils">
<dt>15 Apr. 15: <strong>Picos</strong> <a class="reference internal" href="download.html#download"><em>1.1.0</em></a> <strong>Released</strong></dt> <dt>15 Apr. 15: <strong>Picos</strong> <a class="reference internal" href="download.html#download"><em>1.1.0</em></a> <strong>Released</strong></dt>
<dd><ul class="first last simple"> <dd><ul class="first last simple">
<li>PICOS is now compatible with <strong>python 3+</strong> (and remains compatible with python 2.6+). Many thanks to <a class="reference external" href="http://www.unibo.it/faculty/sergio.callegari">Sergio Callegari</a> 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).</li> <li>PICOS is now compatible with <strong>python 3+</strong> (and remains compatible with python 2.6+). Many thanks to <a class="reference external" href="http://www.unibo.it/faculty/sergio.callegari">Sergio Callegari</a> 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).</li>
<li>PICOS is now available on <strong>github</strong>.</li> <li>PICOS is now available on <a class="reference external" href="http://github.com/gsagnol/picos">github</a>.</li>
</ul> </ul>
</dd> </dd>
</dl> </dl>
......
...@@ -8,6 +8,11 @@ ...@@ -8,6 +8,11 @@
Change History Change History
============== ==============
* 15 Apr. 15: **Picos** :ref:`1.1.0 <download>` **Released**
* 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).
* PICOS is now available on `github <http://github.com/gsagnol/picos>`_.
* 30 Jan. 15: **Picos** :ref:`1.0.2 <download>` **Released** |br| * 30 Jan. 15: **Picos** :ref:`1.0.2 <download>` **Released** |br|
Major release with following new functionalities: Major release with following new functionalities:
......
...@@ -18,9 +18,13 @@ see more about PICOS in the :ref:`introduction <intro>`. ...@@ -18,9 +18,13 @@ see more about PICOS in the :ref:`introduction <intro>`.
The latest version can be downloaded :ref:`here <download>`, The latest version can be downloaded :ref:`here <download>`,
and can be installed by following :ref:`these instructions <requirements>`. and can be installed by following :ref:`these instructions <requirements>`.
Alternatively, you can clone the latest development version from **github**:
``$ git clone https://github.com/gsagnol/picos.git``.
This documentation contains a :ref:`tutorial <tuto>` and some :ref:`examples <examples>`, This documentation contains a :ref:`tutorial <tuto>` and some :ref:`examples <examples>`,
which should already be enough for a quick start with PICOS. To go deeper, 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,
have a look at the :ref:`picos reference <api>`, which provides information have a look at the :ref:`picos reference <api>`, which provides information
on every function of PICOS. on every function of PICOS.
...@@ -28,9 +32,9 @@ on every function of PICOS. ...@@ -28,9 +32,9 @@ on every function of PICOS.
**News** **News**
* 15 Apr. 15: **Picos** :ref:`1.1.0 <download>` **Released** * 15 Apr. 15: **Picos** :ref:`1.1.0 <download>` **Released**
* 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). * 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).
* PICOS is now available on **github**. * PICOS is now available on `github <http://github.com/gsagnol/picos>`_.
* 30 Jan. 15: **Picos** :ref:`1.0.2 <download>` **Released** * 30 Jan. 15: **Picos** :ref:`1.0.2 <download>` **Released**
......
...@@ -273,7 +273,7 @@ returns the list of correctly installed solvers. ...@@ -273,7 +273,7 @@ returns the list of correctly installed solvers.
Requirements Requirements
============ ============
PICOS has two dependencies: `numpy <http://numpy.scipy.org/>`_ PICOS has three dependencies: `six <http://pythonhosted.org//six/>`_ , `numpy <http://numpy.scipy.org/>`_
and and
`cvxopt <http://abel.ee.ucla.edu/cvxopt/>`_. (cvxopt is needed even if you `cvxopt <http://abel.ee.ucla.edu/cvxopt/>`_. (cvxopt is needed even if you
do not use the cvxopt solvers, because picos relies on the do not use the cvxopt solvers, because picos relies on the
...@@ -312,6 +312,15 @@ To test your installation, you can run the test file: ...@@ -312,6 +312,15 @@ To test your installation, you can run the test file:
This will generate a table with a list of results This will generate a table with a list of results
for each available solver and class of optimization problems. for each available solver and class of optimization problems.
Alternatively, you can clone the latest development version from `github <http://github.com/gsagnol/picos>`_:
.. code-block:: guess
$ git clone https://github.com/gsagnol/picos.git
in a directory that lies in your ``PYTHONPATH``.
License License
======= =======
...@@ -337,10 +346,14 @@ Author and contributors ...@@ -337,10 +346,14 @@ Author and contributors
* Contributors: People who actively contributed to the code of Picos (in no particular order) * Contributors: People who actively contributed to the code of Picos (in no particular order)
* `Sergio Callegari <http://www.unibo.it/faculty/sergio.callegari>`_
* `Petter Wittek <http://peterwittek.com/>`_ * `Petter Wittek <http://peterwittek.com/>`_
* Paul Fournel * Paul Fournel
* Arno Ulbricht
* Bertrand Omont * Bertrand Omont
* Contributors: People who contributed to the improvement of Picos by sending * Contributors: People who contributed to the improvement of Picos by sending
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment