libqasm 0.6.6__cp311-cp311-macosx_11_0_universal2.whl

libqasm-0.6.6.dist-info/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright [2018] [QCA Lab, QuTech, TU Delft]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

libqasm-0.6.6.dist-info/METADATA

@@ -0,0 +1,224 @@
+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

@@ -0,0 +1,16 @@
+cqasm/__init__.py,sha256=MsSFjiLMLJZ7QhUPpVBWKiyDnCzryquRyr329NoCACI,2
+cqasm/v3x/__init__.py,sha256=S2V6EAh1mNbDyNoA1tZfjZ-Pgykqry_LeA_KEhqTjZY,2785
+cqasm/v3x/ast.py,sha256=Vng_gxnIBqbNrEa9ElHIUDLBWEEXQGCagddx6AnbgFc,409207
+cqasm/v3x/instruction.py,sha256=AEOwKV2riafpyTiJvgq7azwOhyhhZfpKV12uWWJ5M2A,1177
+cqasm/v3x/primitives.py,sha256=ESCsMHP1GeuKh2gHQSP0ha24Abp453U-I7JSGK9dZas,1664
+cqasm/v3x/semantic.py,sha256=7JB7EU2QL6m4LZC8uPp-giGVRUa_RwKzlci1PA4LRIg,86312
+cqasm/v3x/types.py,sha256=izXYdNmYvJUcRSZVLJ-blPnU2TmhOGR1Z3Rhtk8rTOQ,63328
+cqasm/v3x/values.py,sha256=YY_41YQ7iU2te7FqtstGnQJd4W3CFH7LmkawSKh5e_A,61680
+libqasm/__init__.py,sha256=liVJFi24VHbmUU-9lBA6hm-xPpF1DgzXMsZ0f1dqO3E,727
+libqasm/_libqasm.cpython-311-darwin.so,sha256=chnYrigzn9eJYOSkhIutiASmdQCelK3ZyOeG8gaDtWs,4053544
+libqasm/libqasm.py,sha256=io7NCBJdhdoguyRWGAWCKjc4fQnLL9Wngta4a9MXM9M,30595
+libqasm-0.6.6.dist-info/LICENSE.md,sha256=duRlJgy46W8Cw_IQjOmud5xJUvgJkX6pkBmBJkoKi4I,566
+libqasm-0.6.6.dist-info/METADATA,sha256=7v_psmJ26_kET6lU0_dLWtyG0HNzXZ21k9l1dEUmpDc,6551
+libqasm-0.6.6.dist-info/WHEEL,sha256=glY0sLhbhKy3BH8OyUaaEklHTnmWvOLHk7hCrHyRQtY,115
+libqasm-0.6.6.dist-info/top_level.txt,sha256=iZ8PSLyg3lJwvSUCvWE8VCJGU-nmQY2YIrbMe7M7kLw,14
+libqasm-0.6.6.dist-info/RECORD,,

libqasm-0.6.6.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: false
+Tag: cp311-cp311-macosx_11_0_universal2
+

libqasm-0.6.6.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+cqasm
+libqasm