libqasm 0.6.6__cp310-cp310-win_amd64.whl → 0.6.8__cp310-cp310-win_amd64.whl

libqasm/libqasm.py

@@ -1,5 +1,5 @@
 # This file was automatically generated by SWIG (https://www.swig.org).
-# Version 4.1.1
+# Version 4.2.1
 #
 # Do not make changes to this file unless you know what you are doing - modify
 # the SWIG interface file instead.
@@ -443,11 +443,6 @@ class ostream(ios):
 
 # Register ostream in _libqasm:
 _libqasm.ostream_swigregister(ostream)
-cin = cvar.cin
-cout = cvar.cout
-cerr = cvar.cerr
-clog = cvar.clog
-
 class istream(ios):
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
     __repr__ = _swig_repr
@@ -507,6 +502,11 @@ class iostream(istream, ostream):
 
 # Register iostream in _libqasm:
 _libqasm.iostream_swigregister(iostream)
+cin = cvar.cin
+cout = cvar.cout
+cerr = cvar.cerr
+clog = cvar.clog
+
 endl_cb_ptr = _libqasm.endl_cb_ptr
 endl = _libqasm.endl
 ends_cb_ptr = _libqasm.ends_cb_ptr
@@ -1046,8 +1046,8 @@ class V3xAnalyzer(object):
         _libqasm.V3xAnalyzer_swiginit(self, _libqasm.new_V3xAnalyzer(*args))
     __swig_destroy__ = _libqasm.delete_V3xAnalyzer
 
-    def register_instruction(self, *args):
-        return _libqasm.V3xAnalyzer_register_instruction(self, *args)
+    def register_instruction(self, name, param_types):
+        return _libqasm.V3xAnalyzer_register_instruction(self, name, param_types)
 
     @staticmethod
     def parse_file(file_name):

libqasm-0.6.8.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.1
+Name: libqasm
+Version: 0.6.8
+Summary: libqasm Python Package
+Home-page: https://github.com/QuTech-Delft/libqasm
+Author: QuTech, TU Delft
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numpy
+
+# libQASM
+
+[![CI](https://github.com/QuTech-Delft/libqasm/workflows/Test/badge.svg)](https://github.com/qutech-delft/libqasm/actions)
+[![Conan Center](https://img.shields.io/conan/v/libqasm)](https://conan.io/center/recipes/libqasm)
+[![PyPI](https://badgen.net/pypi/v/libqasm)](https://pypi.org/project/libqasm/)
+![OS](https://img.shields.io/badge/os-emscripten%20%7C%20linux%20%7C%20macos%20%7C%20windows-blue?style=flat-square)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+libQASM is a library to parse cQASM programs, developed by QuTech. 
+At the moment, libQASM only supports cQASM v3.0 programs
+(see [cQASM-spec](https://qutech-delft.github.io/cQASM-spec/latest/) for the language specification).
+
+It performs lexical, syntactic, and semantic analysis of an input program received via a file or a string.
+It produces one of the following results:
+
+- A syntactic or semantic AST (Abstract Syntax Tree) object. Depending on if we are parsing or analysing.
+- A list of parsing or analysing errors. In case the input program was malformed.
+- A JSON representation of either the AST or the list of errors.
+
+It can be used from:
+
+- C++ projects (as a [Conan package](https://conan.io/center/recipes/libqasm)).
+- Python projects (as a [Python package](https://pypi.org/project/libqasm/)).
+- Emscripten projects (via a Typescript frontend).
+
+Check out [QX simulator](https://github.com/QuTech-Delft/qx-simulator)
+and [OpenSquirrel](https://github.com/QuTech-Delft/OpenSquirrel) compiler
+for an example of use in a C++ and a Python project, respectively.
+
+## Getting started
+
+Given a cQASM program `example.cq`.
+
+```cQASM
+version 3.0
+
+qubit[2] q
+bit[2] b
+
+H q[0]
+CNOT q[0], q[1]
+b = measure q
+```
+
+We can parse or analyze this circuit, using libQASM through the following programming language:
+
+### C++
+
+```cpp
+#include "libqasm/v3x/cqasm-python.hpp"
+
+int main() {
+    auto parse_result = V3xAnalyzer::parse_file("example.cq");
+    
+    auto analyzer = V3xAnalyzer();
+    auto analysis_result = analyzer.analyze_file("example.cq");
+}
+```
+
+
+### Emscripten
+
+The emscripten API only allows to input a cQASM program as a string.
+
+```typescript
+import { default as wrapper } from 'cqasm_emscripten.mjs';
+
+wrapper().then(function(result: any) {
+    let analyzer = new result["EmscriptenWrapper"]()
+    let program = `
+        version 3
+        qubit[2] q
+        bit[2] b 
+        H q[0]
+        CNOT q[0], q[1]
+        b = measure q
+    `
+    let output = analyzer.parse_string_to_json(program)
+    analyzer.delete()
+}).catch((error: any) => {
+    console.error("unhandledRejection", error, "\n");
+});
+```
+
+### Python
+
+```python
+from libqasm import Analyzer
+
+if __name__ == "__main__":
+    parse_result = Analyzer.parse_file('example.cq')
+
+    analyzer = Analyzer()
+    analysis_result = analyzer.analyze_file('example.cq')
+```
+
+## Documentation
+
+The [libQASM documentation](https://QuTech-Delft.github.io/libqasm/) is hosted through GitHub Pages.
+
+## License
+
+libQASM is licensed under the Apache License, Version 2.0.
+See [LICENSE](https://github.com/QuTech-Delft/libqasm/blob/master/LICENSE.md) for the full license text.
+
+## Authors
+
+Quantum Inspire: [support@quantum-inspire.com](mailto:"support@quantum-inspire.com")

libqasm-0.6.8.dist-info/RECORD

@@ -0,0 +1,16 @@
+cqasm/__init__.py,sha256=_6Yl-eMBve0mGQA-aiFg4qvQ7GUCV5eGvIcoRf4mEPw,3
+cqasm/v3x/__init__.py,sha256=s1r1kbfl9iGONOuB7V2HQ6llIbQ0CWiiGVytzjIRPng,4888
+cqasm/v3x/ast.py,sha256=QeHMdDypm7BVatATNlR80G4aJ1rTEj29_V7m39ED0Mk,431365
+cqasm/v3x/instruction.py,sha256=VAOqFpCH94CrutgMUZnQq8JXFIq_-C-ndTOjHLsg6_8,1219
+cqasm/v3x/primitives.py,sha256=lkxg0gHMFba-O803cOh0QqOANFHsZDK0iHvIluFz-qI,2110
+cqasm/v3x/semantic.py,sha256=5nd_aCdVkK6K06hBXf6i98rkv5fbAbFQoXaXHvs2uJs,117716
+cqasm/v3x/types.py,sha256=krT1WB5URT0F7lhKTLwYAs_UtTCn9CZ7-M0WMGmxtU4,65070
+cqasm/v3x/values.py,sha256=SfKw6zIjpMrXJggvN_QGPqsoZXDR7HwUjgUMOBnIzuo,63394
+libqasm/__init__.py,sha256=X0G-HBFW9_uEcsaGROQ1nzxYfHzSuglOiXrpTpjF9_E,752
+libqasm/_libqasm.cp310-win_amd64.pyd,sha256=RQMzHcQ4ycEVAJh8kUp4z2vuXAz50OSw9D0_kSokOhs,2363904
+libqasm/libqasm.py,sha256=nLcGTD9njpy5FSPFp0ZPwvWjzjd6lqEjaa2w1WZZ8RI,31701
+libqasm-0.6.8.dist-info/LICENSE.md,sha256=395F6Sje50f5Too7yWFAoS_owYO4aOtjbMeQd_go_sk,579
+libqasm-0.6.8.dist-info/METADATA,sha256=hPrPSrGVnLqWCY2ta5EaMNgWHQ7G8LCNkRIeJZanghg,4163
+libqasm-0.6.8.dist-info/WHEEL,sha256=IqiWNwTSPPvorR7mTezuRY2eqj__44JKKkjOiewDX64,101
+libqasm-0.6.8.dist-info/top_level.txt,sha256=iZ8PSLyg3lJwvSUCvWE8VCJGU-nmQY2YIrbMe7M7kLw,14
+libqasm-0.6.8.dist-info/RECORD,,

{libqasm-0.6.6.dist-info → libqasm-0.6.8.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (75.2.0)
 Root-Is-Purelib: false
 Tag: cp310-cp310-win_amd64
 

libqasm-0.6.6.dist-info/METADATA

@@ -1,224 +0,0 @@
-Metadata-Version: 2.1
-Name: libqasm
-Version: 0.6.6
-Summary: libqasm Python Package
-Home-page: https://github.com/QuTech-Delft/libqasm
-Author: QuTech, TU Delft
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Operating System :: MacOS
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Topic :: Scientific/Engineering
-Description-Content-Type: text/markdown
-License-File: LICENSE.md
-Requires-Dist: numpy
-
-# libQASM: Library to parse cQASM v3.0 files
-
-[![CI](https://github.com/QuTech-Delft/libqasm/workflows/Test/badge.svg)](https://github.com/qutech-delft/libqasm/actions)
-[![PyPI](https://badgen.net/pypi/v/libqasm)](https://pypi.org/project/libqasm/)
-
-## File organization
-
-For development, see:
-
-- `include`: public headers.
-- `src`: source files.
-- `test`: test files.
-- `python`: SWIG interface.
-- `res`: resource files, for testing.
-
-For build process, continuous integration, and documentation:
-
-- `conan`: Conan profiles.
-- `emscripten`: bindings and test for the emscripten binaries.
-- `scripts`: helper scripts used during the build process.
-- `.github`: GitHub Actions configuration files.
-- `doc`: documentation.
-
-Build outputs may go into:
-
-- `build/<build type>`: the C++ library output files generated by Conan.
-- `pybuild`: the Python library output files generated by `setup.py`.
-
-## Dependencies
-
-* C++ compiler with C++20 support (gcc 11, clang 14, msvc 17)
-* `CMake` >= 3.12
-* `git`
-* `Python` 3.x plus `pip`, with the following package:
-  * `conan` >= 2.0
-  
-### ARM specific dependencies
-
-We are having problems when using the `zulu-opendjk` Conan package on an ARMv8 architecture.
-`zulu-openjdk` provides the Java JRE required by the ANTLR generator.
-So, for the time being, we are installing Java manually for this platform.
-
-* `Java JRE` >= 11
-
-## Build
-
-This version of `libqasm` can only be compiled via the Conan package manager.
-You'll need to create a default profile before using it for the first time.
-
-The installation of dependencies, as well as the compilation, can be done in one go.
-
-```
-git clone https://github.com/QuTech-Delft/libqasm.git
-cd libqasm
-conan profile detect
-conan build . -pr:a=conan/profiles/tests-debug -b missing
-```
-
-Notice:
-- the `conan profile` command only has to be run only once, and not before every build.
-- the `conan build` command is building `libqasm` in Debug mode with tests using the `tests-debug` profile.
-- the `-b missing` parameter asks `conan` to build packages from sources
-in case it cannot find the binary packages for the current configuration (platform, OS, compiler, build type...). 
-
-### Build profiles
-
-A group of predefined profiles is provided under the `conan/profiles` folder.<br/>
-They follow the `[tests](-build_type)(-compiler)(-os)(-arch)[-shared]` naming convention:
-  - `tests`: if tests are being built.
-  - `build_type`: can be `debug` or `release`.
-  - `compiler`: `apple-clang`, `clang`, `gcc`, `msvc`.
-  - `os`: `emscripten`, `linux`, `macos`, `windows`.
-  - `arch`: `arm64`, `wasm`, `x64`.
-  - `shared`: if the library is being built in shared mode.
-
-All the profiles set the C++ standard to 20.<br/>
-All the `tests`, except for `linux-x64` profiles, enable Address Sanitizer.
-
-### Build options
-
-Profiles are a shorthand for command line options. The command above could be written, similarly,  as: 
-
-```
-conan build . -s:a compiler.cppstd=20 -s:a libqasm/*:build_type=Debug -o libqasm/*:build_tests=True -o libqasm/*:asan_enabled=True -b missing
-```
-
-This is the list of options that could be specified either in a profile or in the command line:
-
-- `libqasm/*:asan_enabled={True,False}`: enables Address Sanitizer.
-- `libqasm/*:build_type={Debug,Release}`: builds in debug or release mode.
-- `libqasm/*:shared={True,False}`: builds a shared object library instead of a static library, if applicable.
-
-Tests are enabled by default. To disable them, use `-c tools.build:skip_test=True`.
-
-## Install
-
-### From Python
-
-Install from the project root directory as follows:
-
-```
-python3 -m pip install --verbose .
-```
-
-You can test if it works by running:
-
-```
-python3 -m pytest
-```
-
-### From C++
-
-The `CMakeLists.txt` file in the root directory includes install targets:
-
-```
-conan create --version 0.6.6 . -pr:a=tests-debug -b missing
-```
-
-You can test if it works by doing:
-
-```
-cd test/Debug
-ctest -C Debug --output-on-failure
-```
-
-## Use from another project
-
-### From Python
-
-The `libqasm` module should provide access to the `V3xAnalyzer` API:
-- `parse_file`,
-- `parse_string`,
-- `analyze_file`, and
-- `analyzer_string`.
-
-The `cqasm.v3x` module is also available for a more fine-grained use of the library.
-
-```
-import cqasm.v3x.ast
-import cqasm.v3x.instruction
-import cqasm.v3x.primitives
-import cqasm.v3x.semantic
-import cqasm.v3x.types
-import cqasm.v3x.values
-```
-
-### From C++
-
-`libqasm` can be requested as a Conan package from a `conanfile.py`.
-
-```
-def build_requirements(self):
-    self.tool_requires("libqasm/0.6.5")
-def requirements(self):
-    self.requires("libqasm/0.6.5")
-```
-
-And then linked against from a `CMakeLists.txt`: 
-
-```
-target_link_libraries(<your target> PUBLIC libqasm::libqasm)
-```
-
-Note that the following dependency is required for `libqasm` to build:
-
-* `Java JRE` >= 11
-
-The header file `cqasm.hpp` should provide access to the following API:
-- `cqasm::v3x::analyze_file`, and
-- `cqasm::v3x::analyze_string`.
-
-Again, other header files are available for a more fine-grained use of the library.
-
-## Docker
-
-This tests the library in a container with the bare minimum requirements for `libqasm`.
-
-```
-docker build .
-```
-
-**Note for Windows users:** The above might fail on Windows due to the `autocrlf` transformation that git does.
-If you are having trouble with this just create new clone of this repository using:
-
-```
-git clone --config core.autocrlf=input git@github.com:QuTech-Delft/libqasm.git
-```
-
-## Emscripten
-
-The generation of emscripten binaries has been tested as a cross-compilation from an ubuntu/x64 platform.
-
-```
-conan build . -pr=conan/profiles/release-clang-emscripten-wasm -pr:b=conan/profiles/release -b missing
-```
-
-The output of this build lives in `build/Release/emscripten`:
-- `cqasm_emscripten.js`.
-- `cqasm_emscripten.wasm`.
-
-Note that `cqasm_emscripten.js` is an ES6 module. An example of how to use it would be:
-
-```
-cd build/Release/emscripten
-mv cqasm_emscripten.js cqasm_emscripten.mjs
-cd ../../../emscripten
-deno run -A test_libqasm.ts
-```

libqasm-0.6.6.dist-info/RECORD

@@ -1,16 +0,0 @@
-cqasm/__init__.py,sha256=_6Yl-eMBve0mGQA-aiFg4qvQ7GUCV5eGvIcoRf4mEPw,3
-cqasm/v3x/__init__.py,sha256=FlmtSTjj083f3t9kTkJBsgs3rQBcgVEkYBqcJ4aKmzs,2850
-cqasm/v3x/ast.py,sha256=snvmnaN80AU5_uJhUAaRsooakjFiMxUG5fUJshkjcVM,420170
-cqasm/v3x/instruction.py,sha256=VAOqFpCH94CrutgMUZnQq8JXFIq_-C-ndTOjHLsg6_8,1219
-cqasm/v3x/primitives.py,sha256=cR3SvCcG5lCzjSFMwHrMSRpf4Bj3Q1tkxUgaaltYJg8,1731
-cqasm/v3x/semantic.py,sha256=wN9awUdn76sNp1WlzV5P4R4Z54r-W0JC4D-xaDzQec4,88679
-cqasm/v3x/types.py,sha256=krT1WB5URT0F7lhKTLwYAs_UtTCn9CZ7-M0WMGmxtU4,65070
-cqasm/v3x/values.py,sha256=SfKw6zIjpMrXJggvN_QGPqsoZXDR7HwUjgUMOBnIzuo,63394
-libqasm/__init__.py,sha256=X0G-HBFW9_uEcsaGROQ1nzxYfHzSuglOiXrpTpjF9_E,752
-libqasm/_libqasm.cp310-win_amd64.pyd,sha256=gMZH-TNtrPu57dyaB0JSljQQA6VA10BQII9hO9EZh2s,2290688
-libqasm/libqasm.py,sha256=TBkHUGljxJ3aWcBoPqTRcftMXAF2cDkwbw6HLP7zZuM,31677
-libqasm-0.6.6.dist-info/LICENSE.md,sha256=395F6Sje50f5Too7yWFAoS_owYO4aOtjbMeQd_go_sk,579
-libqasm-0.6.6.dist-info/METADATA,sha256=Hi6F1jn1w0o-S3SzPjbXbDJUsIMUE5K1Bj3vtNDGzwc,6775
-libqasm-0.6.6.dist-info/WHEEL,sha256=lO6CqtLHCAi38X3Es1a4R1lAjZFvN010IMRCFo2S7Mc,102
-libqasm-0.6.6.dist-info/top_level.txt,sha256=iZ8PSLyg3lJwvSUCvWE8VCJGU-nmQY2YIrbMe7M7kLw,14
-libqasm-0.6.6.dist-info/RECORD,,