Skip to content

Commit afb82ff

Browse files
vsoftcovsoftco
committed
Version 4.3.1
1 parent d7a2fac commit afb82ff

File tree

8 files changed

+49
-45
lines changed

8 files changed

+49
-45
lines changed

‎CHANGES‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Pre-release
1+
Version 4.3.1 - 5 June 2023
22
- CMake dependent flag name changes. These flags can be used in standalone
33
projects when configuring with CMake.
44
USE_OPENQASM2_SPECS -> QASMTOOLS_QASM2_SPECS

‎CMakeLists.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
cmake_minimum_required(VERSION 3.15)
2-
set(QPP_VERSION_NUM 4.3)
2+
set(QPP_VERSION_NUM 4.3.1)
33
set(QPP_VERSION_STR "${QPP_VERSION_NUM}")
44
project(qpp VERSION ${QPP_VERSION_NUM} LANGUAGES CXX)
55
set(CMAKE_CXX_STANDARD 17)

‎Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ RUN apt-get update && \
88

99
RUN apt-get install -y \
1010
build-essential \
11-
python3.6 \
11+
python3.10 \
1212
python3-pip \
1313
python3-dev \
1414
libeigen3-dev \

‎Doxyfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ PROJECT_NAME = Quantum++
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = v4.3
51+
PROJECT_NUMBER = v4.3.1
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a

‎INSTALL.md‎

Lines changed: 42 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ as [Windows](https://www.microsoft.com/en-us/windows).
3838

3939
## Configuring the system
4040

41-
First configure the system via CMake to use an out-of-source build directory
42-
(e.g., `./build`) by executing (in a terminal/console/command prompt) under the
41+
First configure the system via CMake to use an out-of-source build directory
42+
(e.g., `./build`) by executing (in a terminal/console/command prompt) under the
4343
project's root directory
4444

4545
```bash
@@ -49,24 +49,24 @@ cmake -B build
4949
## Building the examples and/or unit tests
5050

5151
To build
52-
the [examples](https://github.com/softwareQinc/qpp/tree/main/examples) and/or
53-
the [unit tests](https://github.com/softwareQinc/qpp/tree/main/unit_tests), you
54-
need to pass the additional
52+
the [examples](https://github.com/softwareQinc/qpp/tree/main/examples) and/or
53+
the [unit tests](https://github.com/softwareQinc/qpp/tree/main/unit_tests), you
54+
need to pass the additional
5555
[optional flags](#cmake-optional-arguments-and-flags)
5656
`WITH_EXAMPLES=ON` and/or `WITH_UNIT_TESTS=ON` to CMake, e.g.,
5757

5858
```bash
5959
cmake -B build -DWITH_EXAMPLES=ON -DWITH_UNIT_TESTS=ON
6060
```
6161

62-
followed by the build command
62+
followed by the build command
6363

6464
```bash
6565
cmake --build build --target=examples --target=unit_tests --parallel 8
6666
```
6767

68-
The above command builds all examples as executables in `./build`,
69-
followed by building the unit tests executable in
68+
The above command builds all examples as executables in `./build`,
69+
followed by building the unit tests executable in
7070
`./build/unit_tests/unit_tests`. The `--parallel 8` instructs CMake to build
7171
in parallel using 8 threads, modify accordingly.
7272

@@ -82,29 +82,33 @@ To build **only** a specific target, execute, e.g.,
8282
cmake --build build --target=bb84
8383
```
8484

85-
The command above only builds the example
86-
[examples/bb84](https://github.com/softwareQinc/qpp/tree/main/examples/bb84)
87-
and outputs the executable `./build/bb84[.exe]`. Reminder: for this to work,
85+
The command above only builds the example
86+
[examples/bb84](https://github.com/softwareQinc/qpp/tree/main/examples/bb84)
87+
and outputs the executable `./build/bb84[.exe]`. Reminder: for this to work,
8888
do not forget to configure the system with the `-DWITH_EXAMPLES=ON` flag.
8989

9090
## CMake optional arguments and flags
9191

92-
| Optional argument | Value | Description |
93-
|--------------------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
94-
| `CMAKE_INSTALL_PREFIX` | `/path/to/install` | Installs Quantum++ header files in a non-standard location (e.g., due to lack of admin. rights) |
95-
| `EIGEN3_INSTALL_DIR` | `/path/to/eigen3` | Path to Eigen3 installation, if not automatically detected. This path can alternatively be enforced by setting the environment variable with the same name, e.g., via `export EIGEN3_INSTALL_DIR=/path/to/eigen3` in UNIX/Linux. |
96-
| | | |
97-
| `QPP_MATLAB` | `ON/OFF` [`OFF` by default] | Enables (if available)/disables interoperability with MATLAB, allowing to detect MATLAB installation automatically. If enabled, allows applications to save/load Quantum++ matrices and vectors to/from MATLAB. |
98-
| `QPP_OPENMP` | `ON/OFF` [`ON` by default] | Enables (if available)/disables OpenMP multi-processing library |
99-
| `QASMTOOLS_QASM2_SPECS` | `ON/OFF` [`OFF` by default] | Enables/disables using the OpenQASM 2.0 standard instead of Qiskit specifications; see [`DISCREPANCIES.md`](https://github.com/softwareQinc/qpp/blob/main/DISCREPANCIES.md) |
100-
| | | |
101-
| `QPP_BIGINT` | `default`, etc. [`default` by default] | Signed big integer type (`qpp::bigint`) |
102-
| `QPP_FP` | `default`, etc. [`default` by default] | Floating-point type (`qpp::realT`) |
103-
| `QPP_IDX` | `default`, etc. [`default` by default] | Integer index type (`qpp::idx`) |
104-
| | | |
105-
| `SANITIZE` | `ON/OFF` [`OFF` by default] | Enable code sanitizing (only for gcc/clang) |
106-
| `WITH_EXAMPLES` | `ON/OFF` [`OFF` by default] | Enables/disables examples as a CMake build target |
107-
| `WITH_UNIT_TESTS` | `ON/OFF` [`OFF` by default] | Enables/disables unit tests as a CMake build target |
92+
Note that all CMake flags below that start with `QPP_` and `QASMTOOLS_`
93+
propagate to subprojects that use Quantum++ in
94+
their corresponding `CMakeLists.txt` via `findpackage(qpp ...)`.
95+
96+
| Optional argument | Value | Description |
97+
|-------------------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
98+
| `CMAKE_INSTALL_PREFIX` | `/path/to/install` | Installs Quantum++ header files in a non-standard location (e.g., due to lack of admin. rights) |
99+
| `EIGEN3_INSTALL_DIR` | `/path/to/eigen3` | Path to Eigen3 installation, if not automatically detected. This path can alternatively be enforced by setting the environment variable with the same name, e.g., via `export EIGEN3_INSTALL_DIR=/path/to/eigen3` in UNIX/Linux. |
100+
| | | |
101+
| `QPP_MATLAB` | `ON/OFF` [`OFF` by default] | Enables (if available)/disables interoperability with MATLAB, allowing to detect MATLAB installation automatically. If enabled, allows applications to save/load Quantum++ matrices and vectors to/from MATLAB. |
102+
| `QPP_OPENMP` | `ON/OFF` [`ON` by default] | Enables (if available)/disables OpenMP multi-processing library |
103+
| `QASMTOOLS_QASM2_SPECS` | `ON/OFF` [`OFF` by default] | Enables/disables using the OpenQASM 2.0 standard instead of Qiskit specifications; see [`DISCREPANCIES.md`](https://github.com/softwareQinc/qpp/blob/main/DISCREPANCIES.md) |
104+
| | | |
105+
| `QPP_BIGINT` | `default`, etc. [`default` by default] | Signed big integer type (`qpp::bigint`) |
106+
| `QPP_FP` | `default`, etc. [`default` by default] | Floating-point type (`qpp::realT`) |
107+
| `QPP_IDX` | `default`, etc. [`default` by default] | Integer index type (`qpp::idx`) |
108+
| | | |
109+
| `SANITIZE` | `ON/OFF` [`OFF` by default] | Enable code sanitizing (only for gcc/clang) |
110+
| `WITH_EXAMPLES` | `ON/OFF` [`OFF` by default] | Enables/disables examples as a CMake build target |
111+
| `WITH_UNIT_TESTS` | `ON/OFF` [`OFF` by default] | Enables/disables unit tests as a CMake build target |
108112

109113
If `QPP_MATLAB=ON` and the system could not detect your MATLAB installation,
110114
you can manually specify the path to MATLAB's installation directory via the
@@ -122,7 +126,7 @@ required libraries and header files via the additional arguments
122126

123127
### UNIX/UNIX-like
124128

125-
To install Quantum++ (after [Configuring the system](#configuring-the-system)),
129+
To install Quantum++ (after [Configuring the system](#configuring-the-system)),
126130
execute in a terminal/console (UNIX/UNIX-like systems)
127131

128132
```bash
@@ -154,18 +158,17 @@ To uninstall, execute in an Administrator Command Prompt
154158
cmake --build build --target UNINSTALL
155159
```
156160

157-
158161
### FreeBSD
159162

160163
We are proud to be part of the [FreeBSD](https://www.freebsd.org/) operating
161-
system as an official package. If you are running FreeBSD, you can install
164+
system as an official package. If you are running FreeBSD, you can install
162165
Quantum++ with
163166

164167
pkg install quantum++
165168

166169
### macOS/Linux
167170

168-
If you are running macOS or Linux, you can install Quantum++ via
171+
If you are running macOS or Linux, you can install Quantum++ via
169172
[Homebrew](https://brew.sh) with
170173

171174
brew install quantum++
@@ -212,14 +215,14 @@ followed by building the application with
212215
cmake --build build
213216
```
214217

215-
The commands above builds the `standalone` executable inside the `build`
218+
The commands above builds the `standalone` executable inside the `build`
216219
directory.
217220

218221
## Building and running a standalone application that uses Quantum++ without a build system
219222

220-
Quantum++ is a header-only library. Hence, you can technically build an
221-
application that uses Quantum++ without using a building system, by simply using
222-
the compiler and specifying the location to all required dependencies, like
223+
Quantum++ is a header-only library. Hence, you can technically build an
224+
application that uses Quantum++ without using a building system, by simply using
225+
the compiler and specifying the location to all required dependencies, like
223226
below (assumes UNIX/UNIX-like, adapt accordingly for Windows)
224227

225228
```bash
@@ -258,8 +261,8 @@ with `make install`.
258261

259262
### macOS/OS X specific instructions
260263

261-
- We highly recommend installing [clang](https://clang.llvm.org/)
262-
via [Homebrew](https://brew.sh/), since the native AppleClang does not offer
264+
- We highly recommend installing [clang](https://clang.llvm.org/)
265+
via [Homebrew](https://brew.sh/), since the native AppleClang does not offer
263266
OpenMP support.
264267
- In case you get any compiler or linker errors when OpenMP is enabled, you need
265268
to install the `libomp` package, e.g., execute
@@ -271,7 +274,8 @@ brew install libomp
271274
### MATLAB support under Windows
272275

273276
If building under Windows
274-
with [MATLAB](https://www.mathworks.com/products/matlab/) support, please add the
277+
with [MATLAB](https://www.mathworks.com/products/matlab/) support, please add
278+
the
275279
location of
276280
`libmx.dll` and `libmat.dll` (the `.dll` **and not** the `.lib` files) to
277281
your `PATH` environment variable. In our case they are located

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Quantum++
22

3-
## Version 4.3 - 26 May 2023
3+
## Version 4.3.1 - 5 June 2023
44

55
[![GitHub actions](https://github.com/softwareqinc/qpp/actions/workflows/cmake.yml/badge.svg)](https://github.com/softwareQinc/qpp/actions)
66

‎VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Version 4.3 - 26 May 2023
1+
Version 4.3.1 - 5 June 2023

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
88

99
[project]
1010
name = "pyqpp"
11-
version = "4.3"
11+
version = "4.3.1"
1212
description = "Python 3 wrapper for Quantum++"
1313
authors = [
1414
{name = "softwareQ Inc.", email = "[email protected]"},

0 commit comments

Comments
 (0)