Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
vsoftco committed Apr 5, 2024
1 parent 5101aba commit 1c86e23
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 20 deletions.
24 changes: 11 additions & 13 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@
**staq** is a full-stack quantum processing toolkit that uses
[CMake](https://cmake.org/) as its build/install system. **staq** is
platform-independent, supporting
[UNIX](https://www.opengroup.org/membership/forums/platform/unix)
(including
[macOS](https://www.apple.com/macos/)) and UNIX-like operating systems
(e.g., [Linux](https://www.linux.org)), as well
as [Windows](https://www.microsoft.com/en-us/windows).
[UNIX](https://www.opengroup.org/membership/forums/platform/unix) (including
[macOS](https://www.apple.com/macos/)) and UNIX-like operating systems (e.g.,
[Linux](https://www.linux.org)), as well as
[Windows](https://www.microsoft.com/en-us/windows).

---

Expand All @@ -26,25 +25,24 @@ as [Windows](https://www.microsoft.com/en-us/windows).

## UNIX/UNIX-like/Windows

To build both tool suite and the **staq** executable, execute
(in a terminal/console/command prompt) under the project's root directory
To build both tool suite and the **staq** executable, execute (in a
terminal/console/command prompt) under the project's root directory

```shell
cmake -B build
```

To be able to install **staq**'s source code in addition to the binaries,
configure
the system with
configure the system with

```shell
cmake -B build -DINSTALL_SOURCES=ON
```

**Important**: If you want to build the grid synth tools `staq_grid_synth`
and `staq_qasm_synth`, install the [GNU MP library](https://gmplib.org/);
`cmake` will take care of the rest. If `cmake` cannot detect GNU MP, then the
grid synth tools will not be part of the build. To install GNU MP on Windows
**Important**: If you want to build the grid synth tools `staq_grid_synth` and
`staq_qasm_synth`, install the [GNU MP library](https://gmplib.org/); `cmake`
will take care of the rest. If `cmake` cannot detect GNU MP, then the grid
synth tools will not be part of the build. To install GNU MP on Windows
systems, please follow the [platform-specific instructions below](#windows).

For more details about how to install and configure GNU MP on various platforms,
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ retrieving the original source code impossible. In particular, OpenQASM 2.0
circuits can be inspected and transformed (in most cases) without losing the
original source structure. This makes **staq** ideally suited for
source-to-source transformations, where only specific changes are desired.
Likewise, this allows translations to other common circuit description languages
and libraries to closely follow the OpenQASM 2.0 source.
Likewise, this allows translations to other common circuit description
languages and libraries to closely follow the OpenQASM 2.0 source.

Check out the [Wiki](https://github.com/softwareQinc/staq/wiki) for more
information about the library and included tools.

Copyright (c) 2013 - 2024 softwareQ Inc. All rights reserved.
Copyright (c) 2019 - 2024 softwareQ Inc. All rights reserved.

---

Expand All @@ -45,8 +45,7 @@ more details.

Please see the installation guide
[`INSTALL.md`](https://github.com/softwareQinc/staq/blob/main/INSTALL.md) and
the
comprehensive [Wiki](https://github.com/softwareQinc/staq/wiki) for further
the comprehensive [Wiki](https://github.com/softwareQinc/staq/wiki) for further
documentation and detailed examples.

---
Expand All @@ -67,8 +66,8 @@ For more details, please see

## Acknowledgements

Thanks to the
excellent [EPFL logic synthesis libraries](https://github.com/lsils/lstools-showcase)
Thanks to the excellent
[EPFL logic synthesis libraries](https://github.com/lsils/lstools-showcase)
which are used to perform logic synthesis in **staq**, and in particular Bruno
Schmitt's [tweedledum](https://github.com/boschmitt/tweedledum) library, from
which the OpenQASM 2.0 parser was adapted.

0 comments on commit 1c86e23

Please sign in to comment.