You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 7, 2021. It is now read-only.
Like for QISKit, at least [Python 3.5 or later](https://www.python.org/downloads/) is needed to use QISKit ACQUA.
35
+
Like for Qiskit, at least [Python 3.5 or later](https://www.python.org/downloads/) is needed to use Qiskit Aqua.
36
36
In addition, [Jupyter Notebook](https://jupyter.readthedocs.io/en/latest/install.html) is recommended for interacting
37
37
with the tutorials. For this reason we recommend installing the [Anaconda 3](https://www.continuum.io/downloads)
38
38
Python distribution, as it comes with all of these dependencies pre-installed.
39
39
40
40
### Getting the Code
41
41
42
-
We encourage you to install QISKit ACQUA via the [pip](https://pip.pypa.io/en/stable/) tool (a Python package manager):
42
+
We encourage you to install Qiskit Aqua via the [pip](https://pip.pypa.io/en/stable/) tool (a Python package manager):
43
43
44
44
```
45
-
pip install qiskit-acqua
45
+
pip install qiskit-aqua
46
46
```
47
47
48
48
pip will handle all dependencies automatically and you will always install the latest (and well-tested) release version.
@@ -51,47 +51,47 @@ We recommend using Python virtual environments to improve your experience.
51
51
52
52
### Running an Algorithm
53
53
54
-
Now that you have installed QISKit ACQUA you can run an algorithm. This can be done [programmatically](#programming)
54
+
Now that you have installed Qiskit Aqua you can run an algorithm. This can be done [programmatically](#programming)
55
55
or can be done using JSON as an input. Whether via dictionary or via JSON the input is validated for correctness against
56
56
schemas.
57
57
58
58
JSON is convenient when the algorithm input has been saved in this form from a prior run. A file containing a saved
59
59
JSON input can be given to either the [GUI](#gui) or the [command line](#command-line) tool in order to run
60
60
the algorithm.
61
61
62
-
One simple way to generate such JSON input is by serializing the input to QISKit ACQUA when executing one of the
63
-
applications running on top of QISKit ACQUA, such as QISKit ACQUA Chemistry, QISKit ACQUA Artificial Intelligence
64
-
or QISKit ACQUA Optimization. The GUI also saves any entered configuration in JSON
62
+
One simple way to generate such JSON input is by serializing the input to Qiskit Aqua when executing one of the
63
+
applications running on top of Qiskit Aqua, such as Qiskit Aqua Chemistry, Qiskit Aqua Artificial Intelligence
64
+
or Qiskit Aqua Optimization. The GUI also saves any entered configuration in JSON
65
65
66
-
The [algorithms](qiskit_acqua/README.md) readme contains detailed information on the various parameters for each
66
+
The [algorithms](aqua/README.md) readme contains detailed information on the various parameters for each
67
67
algorithm along with links to the respective components they use.
68
68
69
69
70
70
### GUI
71
71
72
-
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
72
+
The Qiskit Aqua GUI allows you to load and save a JSON file to run an algorithm, as well as create a new one or edit
73
73
an existing one. So, for example, using the UI, you can alter the parameters of an algorithm and/or its dependent
74
74
objects to see how the changes affect the outcome. The pip install creates a script that allows you to start the GUI
75
75
from the command line, as follows:
76
76
77
77
```
78
-
qiskit_acqua_ui
78
+
qiskit_aqua_ui
79
79
```
80
80
81
81
If you clone and run directly from the repository instead of using the `pip install` recommended way, then the GUI can
82
-
be run, from the root folder of the `qiskit-acqua` repository clone, using
82
+
be run, from the root folder of the `qiskit-aqua` repository clone, using
83
83
84
84
```
85
-
python qiskit_acqua/ui/run
85
+
python qiskit_aqua/ui/run
86
86
```
87
87
88
88
Configuring an experiment that involves both quantum-computing and domain-specific parameters may look like a
89
89
challenging activity, which requires specialized knowledge on both the specific domain in which the experiment runs and
90
-
quantum computing itself. QISKit ACQUA simplifies the configuration of any run in two ways:
90
+
quantum computing itself. Qiskit Aqua simplifies the configuration of any run in two ways:
91
91
92
92
1. Defaults are provided for each parameter. Such defaults have been validated to be the best choices in most cases.
93
93
2. Robust configuration correctness enforcement mechanisms are in place. The input parameters are always schema
94
-
validated by QISKit ACQUA when attempting to run an algorithm. When using the GUI to configure an experiment,
94
+
validated by Qiskit Aqua when attempting to run an algorithm. When using the GUI to configure an experiment,
95
95
the GUI itself prevents incompatible parameters from being selected.
96
96
97
97
### Command Line
@@ -101,47 +101,47 @@ information. The pip install creates a script, which can be invoked with a JSON
101
101
line, for example as follows:
102
102
103
103
```
104
-
qiskit_acqua_cmd examples/H2-0.735.json
104
+
qiskit_aqua_cmd examples/H2-0.735.json
105
105
```
106
106
107
107
If you clone and run direct from the repository instead of using the `pip install` recommended way then it can be
108
-
run, from the root folder of the `qiskit-acqua` repository clone, using
108
+
run, from the root folder of the `qiskit-aqua` repository clone, using
109
109
110
110
```
111
-
python qiskit_acqua
111
+
python qiskit_aqua
112
112
```
113
113
114
114
### Browser
115
115
116
-
As QISKit ACQUA is extensible with pluggable components, we have provided a documentation GUI that shows all the
116
+
As Qiskit Aqua is extensible with pluggable components, we have provided a documentation GUI that shows all the
117
117
pluggable components along with the schema for their parameters. The pip install creates a script to invoke the
118
118
browser GUI as follows:
119
119
120
120
```
121
-
qiskit_acqua_browser
121
+
qiskit_aqua_browser
122
122
```
123
123
124
124
Note: if you clone the repository and want to start the documentation GUI directly from your local repository instead
125
125
of using the `pip install` recommended way, then the documentation GUI can be run, from the root folder of the
126
-
`qiskit-acqua` repository clone, using the following command:
126
+
`qiskit-aqua` repository clone, using the following command:
127
127
128
128
```
129
-
python qiskit_acqua/ui/browser
129
+
python qiskit_aqua/ui/browser
130
130
```
131
131
132
132
### Programming
133
133
134
-
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
134
+
Any algorithm in Qiskit Aqua can be run programmatically too. The aqua folder in the [aqua-tutorials](https://github.com/Qiskit/aqua-tutorials/tree/master/aqua) contains numerous
135
135
samples that demonstrate how to do this. Here you will see there is a `run_algorithm` method used, which takes either
136
136
the JSON algorithm input or an equivalent Python dictionary and optional `AlgorithmInput` object for the algorithm.
137
137
There is also a `run_algorithm_to_json` that simply takes the input and saves it to JSON in a self-contained form,
138
138
which can later be used by the command line or GUI.
139
139
140
140
## Authors
141
141
142
-
QISKit ACQUA was inspired, authored and brought about by the collective work of a team of researchers.
142
+
Qiskit Aqua was inspired, authored and brought about by the collective work of a team of researchers.
143
143
144
-
QISKit ACQUA continues now to grow with the help and work of [many people](./CONTRIBUTORS.md), who contribute
144
+
Qiskit Aqua continues now to grow with the help and work of [many people](./CONTRIBUTORS.md), who contribute
0 commit comments