libqasm 0.6.5__cp312-cp312-macosx_10_10_universal2.whl → 0.6.6__cp312-cp312-macosx_10_10_universal2.whl

{libqasm-0.6.5.dist-info → libqasm-0.6.6.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: libqasm
-Version: 0.6.5
-Summary: libQasm Python Package
+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
@@ -80,28 +80,34 @@ in case it cannot find the binary packages for the current configuration (platfo
 
 ### Build profiles
 
-A group of predefined profiles is provided under the `conan/profiles` folder.
-They follow the `[tests-](debug|release)[-compat]` naming convention. For example:
-  - `release` is a Release build without tests and compatibility with the original API.
-  - `tests-debug-compat` is a Debug build with tests and compatibility enabled.
+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. All the `tests` profiles enable Address Sanitizer.
+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 as well as: 
+Profiles are a shorthand for command line options. The command above could be written, similarly,  as: 
 
 ```
-conan build . -s:h compiler.cppstd=20 -s:h libqasm/*:build_type=Debug -o libqasm/*:build_tests=True -o libqasm/*:asan_enabled=True -b missing
+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
 ```
 
-These are the list of options that could be specified whether in a profile or in the command line:
+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_tests={True,False}`: builds tests or not.
 - `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
@@ -123,7 +129,7 @@ python3 -m pytest
 The `CMakeLists.txt` file in the root directory includes install targets:
 
 ```
-conan create --version 0.5.2 . -pr=tests-debug -b missing
+conan create --version 0.6.6 . -pr:a=tests-debug -b missing
 ```
 
 You can test if it works by doing:
@@ -137,30 +143,49 @@ ctest -C Debug --output-on-failure
 
 ### From Python
 
-After installation, you should be able to use the bindings for the original API by just `import libQasm`.
-The new API doesn't have Python bindings yet.
+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++
 
-The easiest way to use `libqasm` in a CMake project is to fetch the library and then link against it.
+`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`: 
 
 ```
-include(FetchContent)
-FetchContent_Declare(cqasm
-    GIT_REPOSITORY https://github.com/QuTech-Delft/libqasm.git
-    GIT_TAG "<a given cqasm git tag>"
-)
-FetchContent_MakeAvailable(cqasm)
-target_include_directories(<your target> SYSTEM PRIVATE "${cqasm_SOURCE_DIR}/include")
-target_link_libraries(<your target> PUBLIC cqasm)
+target_link_libraries(<your target> PUBLIC libqasm::libqasm)
 ```
 
 Note that the following dependency is required for `libqasm` to build:
 
 * `Java JRE` >= 11
 
-The original API headers are *not* included by default.
-To enable those, pass <code><nobr>-o libqasm/*:compat=True</nobr></code> as a build option to Conan.
+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
 
@@ -170,7 +195,7 @@ This tests the library in a container with the bare minimum requirements for `li
 docker build .
 ```
 
-**Note for Windows users:** The above might fail on Windows to the autocrlf transformation that git does.
+**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:
 
 ```
@@ -182,9 +207,18 @@ git clone --config core.autocrlf=input git@github.com:QuTech-Delft/libqasm.git
 The generation of emscripten binaries has been tested as a cross-compilation from an ubuntu/x64 platform.
 
 ```
-conan build . -pr=conan/profiles/emscripten -pr:b=conan/profiles/release -b missing
+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-312-darwin.so,sha256=GRLtdq-Yo2cA9q5JvOumBGUTI2BDWvUmj2y_a4lV1F8,4253096
+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=bCe9NkCcZZhnfFYccFz_TeJCD_m2mB9psi4akKL7FvI,116
+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/top_level.txt

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