Merge pull request #30 from manoelmarques/stable-0.1.2

New Release 0.1.2

Author: manoelmarques

.gitignore

@@ -95,6 +95,7 @@ docs/_build/
 docs/*.rst
 #Allow
 !docs/dev_introduction.rst
+!docs/qiskit-acqua.rst
 !docs/index.rst
 !docs/install.rst
 !docs/quickstart.rst
@@ -107,7 +108,7 @@ docs/*.rst
 !docs/oracles.rst
 !docs/extending.rst
 !docs/initial_states.rst
-!docs/additional.rst
+!docs/problem_backend_config.rst
 
 # PyBuilder
 target/

CHANGELOG.rst

@@ -18,6 +18,37 @@ The format is based on `Keep a Changelog`_.
 `UNRELEASED`_
 =============
 
+`0.1.2`_ - 2018-07-12
+=====================
+
+Added
+-----
+
+- UI Preferences Page including proxies urls, provider, verify.
+- Add help menu with link to documentation.
+- Add num_iterations param to grover.
+- Graph partition ising model added.
+- F2 finite field functions and find_Z2_symmetries function.
+- Added packages preferences array for client custom pluggable packages.
+
+Changed
+-------
+
+- Clean up use_basis_gates options.
+- Change QISKit registering for QISKit 0.5.5.
+
+Fixed
+-----
+
+- GUI - Windows: new line appears when text view dismissed.
+- Update test_grover to account for cases where the groundtruth info is missing.
+- Qconfig discovery - Fix permission denied error on list folders.
+- UI Fix Popup cut/copy/paste/select all behavior in mac/windows/linux.
+- Fix typo grouped paulis.
+- Fix numpy argmax usage on potentially complex state vector.
+- Fix/use list for paulis and update helper function of ising model.
+
+
 `0.1.1`_ - 2018-06-13
 =====================
 
@@ -37,7 +68,8 @@ Changed
 - Updated qiskit minimum version in setup.py.
 - Fixed links in readme.me.
 
-.. _UNRELEASED: https://github.com/QISKit/qiskit-acqua/compare/0.1.1...HEAD
+.. _UNRELEASED: https://github.com/QISKit/qiskit-acqua/compare/0.1.2...HEAD
+.. _0.1.2: https://github.com/QISKit/qiskit-acqua/compare/0.1.1...0.1.2
 .. _0.1.1: https://github.com/QISKit/qiskit-acqua/compare/0.1.0...0.1.1
 
 .. _Keep a Changelog: http://keepachangelog.com/en/1.0.0/

README.md

@@ -131,7 +131,7 @@ python qiskit_acqua/ui/browser
 
 ### Programming
 
-Any algorithm in QISKit ACQUA can be run programmatically too. The [examples](./examples) folder contains numerous
+Any algorithm in QISKit ACQUA can be run programmatically too. The acqua folder in the [qiskit-acqua-tutorials](https://github.com/QISKit/qiskit-acqua-tutorials/tree/master/acqua) contains numerous
 samples that demonstrate how to do this. Here you will see there is a `run_algorithm` method used, which takes either
 the JSON algorithm input or an equivalent Python dictionary and optional `AlgorithmInput` object for the algorithm.
 There is also a `run_algorithm_to_json` that simply takes the input and saves it to JSON in a self-contained form,

docs/ACQUAArchitecture.png

@@ -5,6 +5,7 @@ This work is the result of the efforts of many people. Many thanks to
 everyone involved in the project:
 
 -  Panagiotis Barkoutsos
+-  Sergey Bravyi
 -  Chun-Fu (Richard) Chen
 -  Antonio Córcoles-Gonzalez
 -  Jay Gambetta

docs/CONTRIBUTORS.rst

@@ -65,9 +65,9 @@ Additionally, VQE can be configured with the following parameters:
 
    .. code:: python
 
-       operator_mode : "matrix" | "paulis" | "group_paulis"
+       operator_mode : "matrix" | "paulis" | "grouped_paulis"
 
-   If no value for ``operator_mode`` ia specified, the default is ``"matrix"``. 
+   If no value for ``operator_mode`` ia specified, the default is ``"matrix"``.
 
 -  The initial point for the search of the minimum eigenvalue:
 
@@ -111,25 +111,25 @@ Dynamics can be configured with the following parameter settings:
 -  Evolution time:
 
    .. code:: python
-   
+
        evo_time : float
 
    A number is expected.  The minimum value is ``0.0``.  The default value is ``1.0``.
 
 -  The evolution mode of the computation:
 
-   .. code:: python 
+   .. code:: python
 
        evo_mode = "matrix" | "circuit"
 
    Two ``string`` values are permitted: ``"matrix"`` or ``"circuit"``, with ``"circuit"`` being the default.
 
--  The number of time slices: 
+-  The number of time slices:
 
    .. code:: python
 
        num_time_slices = 0 | 1 | ...
-   
+
    This has to be a non-negative ``int`` value.  The default is ``1``.
 
 -  Paulis grouping mode:
@@ -141,7 +141,7 @@ Dynamics can be configured with the following parameter settings:
    Two ``string`` values are permitted: ``"default"`` or ``"random"``, with ``"default"`` being the default and indicating
    that the paulis should be grouped.
 
--  The expansion mode: 
+-  The expansion mode:
 
    .. code:: python
 
@@ -191,7 +191,7 @@ state <initial_states.html>`__ and an `IQFT <./iqfts.html>`__.
 
 QPE is also configured with the following parameter settings:
 
--  The number of time slices: 
+-  The number of time slices:
 
    .. code:: python
 
@@ -227,7 +227,7 @@ QPE is also configured with the following parameter settings:
 
 -  The number of ancillae:
 
-   .. code:: python 
+   .. code:: python
 
        num_ancillae = 1 | 2 | ...
 
@@ -248,7 +248,7 @@ Iterative Quantum Phase Estimation (IQPE)
 
 IQPE, as its name
 suggests, iteratively computes the phase so as to require less qubits.
-It takes in the same set of parameters as :ref:`Quantum Phase Estimation (QPE)`, except for the number of
+It takes in the same set of parameters as `QPE <#quantum-phase-estimation-qpe>`__, except for the number of
 ancillary qubits ``num_ancillae``, which is replaced by
 ``num_iterations`` (a positive ``int``, also defaulted to ``1``), and for the fact that an `IQFT <./iqfts.html>`__ is not
 used for IQPE.
@@ -330,15 +330,14 @@ the category of what is called *supervised learning*, consisting of a
 obtained) and a *test or classification phase* (where new labeless data
 is classified according to the solution found in the training phase).
 
-SVM Q Kernel can be configured with the following parameter:
+SVM Q Kernel can be configured with a Boolean parameter, indicating
+whether or not to print additional information when the algorithm is running:
 
--  A Boolean indicating whether or not to print additional information when the algorithm is running:
+.. code:: python
 
-   .. code:: python
+    print_info : bool
 
-       print_info : bool
-
-   A Boolean value is expected.  The default is ``False``.
+The default is ``False``.
 
 .. topic:: Declarative Name
 
@@ -405,15 +404,13 @@ Exact Eigensolver
 
 Exact Eigensolver computes up to the first ``k`` eigenvalues of a complex square matrix of dimension ``n x n``,
 with ``k`` :math:`leq` ``n``.
-It can be configured with the following parameter:
-
--  The number of eigenvalues to compute:
+It can be configured with an integer parameter indicating the number of eigenvalues to compute:
 
-   .. code:: python
+.. code:: python
 
-       k = 1 | 2 | ... | n
+    k = 1 | 2 | ... | n
 
-   An ``int`` value ``k`` in the range :math:`[1,n]` is expected. The default is ``1``.
+Specifically, the value of this parameter must be an ``int`` value ``k`` in the range :math:`[1,n]`. The default is ``1``.
 
 .. topic:: Declarative Name
 
@@ -480,15 +477,14 @@ Support Vector Machine Radial Basis Function Kernel (SVM RBF Kernel)
 
 This algorithm uses a classical approach to experiment with feature map classification
 problems.
-SVM RBF Kernel can be configured with the following parameter:
-
--  A Boolean indicating whether or not to print additional information when the algorithm is running:
+SVM RBF Kernel can be configured with a Boolean parameter,
+indicating whether or not to print additional information when the algorithm is running:
 
-   .. code:: python
+.. code:: python
 
-       print_info : bool
+    print_info : bool
 
-   A Boolean value is expected.  The default is ``False``.
+The default value for this parameter is ``False``.
 
 .. topic:: Declarative Name
 

docs/algorithms.rst

@@ -25,7 +25,7 @@ Table of Contents
    Inverse Quantum Fourier Transforms <iqfts>
    Oracles <oracles>
    Extending QISKit ACQUA <extending>
-   Additional Configuration <additional> 
+   Problem and Backend Configuration <problem_backend_config> 
    Getting Started <quickstart>
    Developer Documentation <dev_introduction>
    SDK Reference <_autodoc/qiskit_acqua>
@@ -47,6 +47,4 @@ Main Modules
 
 Authors (alphabetical)
 ======================
-Panagiotis Barkoutsos, Chun-Fu (Richard) Chen, Antonio Córcoles-Gonzalez, Jay Gambetta, Shaohan Hu, Takashi Imamichi,
-Tal Kachman, Peng Liu, Manoel Marques, Antonio Mezzacapo, Nikolaj Moll, Giacomo Nannicini, Marco Pistoia, Julia Rice,
-Raymond Harry Putra Rudy, Ivano Tavernelli, Stephen Wood
+Panagiotis Barkoutsos, Sergey Bravyi, Chun-Fu (Richard) Chen, Antonio Córcoles-Gonzalez, Jay Gambetta, Shaohan Hu, Takashi Imamichi, Tal Kachman, Peng Liu, Manoel Marques, Antonio Mezzacapo, Nikolaj Moll, Giacomo Nannicini, Marco Pistoia, Julia Rice, Raymond Harry Putra Rudy, Ivano Tavernelli, Stephen Wood

docs/index.rst

@@ -41,7 +41,7 @@ Running an Algorithm
 
 Now that you have installed QISKit ACQUA, you can run an algorithm by invoking it with the appropriate input.
 The input to a QISKit ACQUA algorithm is expected to be in `JSON <http://json.org>`__ format.
-This can be done programmaticall, via the Graphical User Interface (GUI) or from the command line.  In addition to the input itself,
+This can be done programmatically, via the Graphical User Interface (GUI) or from the command line.  In addition to the input itself,
 the JSON file encodes the algorithm that QISKit ACQUA will invoke on that input.
 One way to generate the JSON input is by
 serializing the input to QISKit ACQUA when executing one of the applications running on top of QISKit ACQUA,
@@ -51,7 +51,7 @@ GUI
 ~~~
 The QISKit ACQUA GUI allows you to load and save a JSON file to run an algorithm
 as well as create a new one or edit an existing one. So, for example,
-using the UI, you can alter the parameters of an  algorithm and/or its dependent
+using the UI, you can alter the parameters of an algorithm and/or its dependent
 objects to see how the changes affect the outcome. pip installs a
 small script that allows you to start the GUI from the command line, as follows:
 
@@ -70,7 +70,7 @@ from the root folder of the ``qiskit-acqua`` repository clone.
 
 Configuring an experiment that involves both quantum-computing and domain-specific parameters
 may look like a challenging activity, which requires specialized knowledge on both the specific
-domain in which the experiment runs and quantum computing itslf.  QISKit ACQUA simplifies the
+domain in which the experiment runs and quantum computing itself.  QISKit ACQUA simplifies the
 configuration of any run in two ways:
 
 1. Defaults are provided for each parameter.  Such defaults have been validated to be the best choices in most cases.
@@ -81,7 +81,7 @@ Command Line
 ~~~~~~~~~~~~
 
 The command line tool will run an algorithm from the supplied JSON file.
-Run without any arguments, it will print help ibformation.  pip installs a
+Run without any arguments, it will print help information.  pip installs a
 small script, which can be invoked with a JSON algorithm input file from the command line as follows:
 
 .. code:: sh
@@ -103,7 +103,7 @@ Browser
 
 As QISKit ACQUA is extensible with pluggable components, we have provided
 a documentation GUI that shows all the pluggable components along with the schema for
-their parameters. ``pip`` installsa small script to invoke the
+their parameters. ``pip`` installs a small script to invoke the
 browser GUI as follows:
 
 .. code:: sh
@@ -124,7 +124,7 @@ from the root folder of the
 Programming
 ~~~~~~~~~~~
 
-Any algoirithm in QISJit ACQUA can be run programmatically too. The
+Any algorithm in QISKit ACQUA can be run programmatically too. The
 ``examples`` folder contains numerous cases that explain  how to do this. Here you will
 see there is a ``run_algorithm`` method used, which takes either the JSON algorithm input
 or an equivalent Python dictionary and optional ``AlgorithmInput`` object

docs/install.rst

@@ -14,7 +14,7 @@ among all possible solutions.
 
 .. topic:: Extending the Optimizer Library
     Consistent with its unique  design and architecture, QISKit ACQUA has a modular and
-    extensible architecture. Algorithms and their supporting objects, such as optimizers for quantum vational algorithms,
+    extensible architecture. Algorithms and their supporting objects, such as optimizers for quantum variational algorithms,
     are pluggable modules in QISKit ACQUA. This was done in order to encourage researchers and developers interested in
     quantum algorithms to extend the QISKit ACQUA framework with their novel research contributions.
     New optimizers for quantum variational algorithms should be installed in the ``qiskit_acqua/utils/optimizers`` folder and derive from the
@@ -72,7 +72,7 @@ The following parameters are supported:
 
         tol : float
 
-   This parameter is optional.  If specified, the value of this parameter must be a number, otherwise, it is  ``Nonw``.
+   This parameter is optional.  If specified, the value of this parameter must be a number, otherwise, it is  ``None``.
    The default is ``None``.
 
 .. topic:: Declarative Name
@@ -127,8 +127,8 @@ Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The target goal of L-BFGS-B is to minimize the value of a differentiable scalar function :math:`f`. 
-This optimizer is a *quasi-Newton method*, meaning tha, in contrast to *Newtons's method*, it 
-does not require :math:f's *Hessian* (the matrix of :math:`f`'s second derivatives)
+This optimizer is a *quasi-Newton method*, meaning that, in contrast to *Newtons's method*, it 
+does not require :math:`f`'s *Hessian* (the matrix of :math:`f`'s second derivatives)
 when attempting to compute :math:`f`'s minimum value.
 Like BFGS, L-BFGS is an iterative method for solving unconstrained, non-linear optimization problems, but approximates 
 BFGS using a limited amount of computer memory.
@@ -247,7 +247,7 @@ The following parameters are supported:
 Parallel Broyden-Fletcher-Goldfarb-Shann (P-BFGS)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-P-BFGS is a parallellized version of  :ref:`Limited-memory Broyden-Fletcher-Goldfarb-Shanno Bound (L-BFGS-B)`,
+P-BFGS is a parallellized version of  `L-BFGS-B <#limited-memory-broyden-fletcher-goldfarb-shanno-bound-l-bfgs-b>`__,
 with which it shares the same parameters.
 P-BFGS can be useful when the target hardware is a quantum simulator running on a classical
 machine. This allows the multiple processes to use simulation to
@@ -385,7 +385,7 @@ The following parameters are supported:
 
        tol : number
 
-   This parameter is optional.  If specified, the value of this parameter must be a number, otherwise, it is  ``Nonw``.
+   This parameter is optional.  If specified, the value of this parameter must be a number, otherwise, it is  ``None``.
    The default is ``None``.
 
 .. topic:: Declarative Name
@@ -533,7 +533,7 @@ The following parameters are supported:
 
         tol : number
 
-   This parameter is optional.  If specified, the value of this parameter must be a number, otherwise, it is  ``Nonw``.
+   This parameter is optional.  If specified, the value of this parameter must be a number, otherwise, it is  ``None``.
    The default is ``None``
 
 .. topic:: Declarative Name