Serialise Qiskit objects with ASDF.
Project description
[!IMPORTANT] This code was originally in a mono-repo with Aardvark, now being renamed to Exprés, but has been separated into a new repo. There may still be some mentions of Aardvark in the docs and code during the renaming/refactor.
[!CAUTION] ASDF Qiskit is still a WIP and volatile. The library is primarily for personal use in our PhD research at IBM Research, Zürich, though anyone is welcome to use it. In its current state, it is not guaranteed that data saved with this version will be loadable in future versions, though we do aim for backwards compatibility during this time.
[!IMPORTANT] Not all Qiskit objects are currently serialisable by ASDF Qiskit. For a complete list, see the supported types in the documentation.
ASDF Qiskit
asdf-qiskit is an ASDF extension that
supports serialising Qiskit objects into human-readable
YAML-like files. Our goal is to support most important Qiskit classes and data
containers, with backwards compatibility to load old experimental data with
newer versions of Qiskit and Python.
Installation
In the near future, we will publish asdf-qiskit to PyPI. Until then, if you
would like to try asdf-qiskit you can run the command, below, and then use
ASDF as normal. Note that the current version is 0.1.1.
pip install "git+ssh://git@github.com/conradhaupt/asdf-qiskit.git@main"
Dependencies
asdf-qiskit requires Qiskit and ASDF. We enforce PyYAML versions greater than
6.0.2 to ensure compatibility with Python 3.13.
Usage
As asdf-qiskit is an extension for ASDF, it is best to use their overview
guide.
The only change between their guide and usage with asdf-qiskit is that Qiskit
objects can now be saved and loaded with ASDF.
Documentation
The documentation will be hosted with Github pages soon. As the code progresses, the documentation will be updated. The most up-to-date and extensive parts of the docs are the guides.
Contributing
All contributions are welcome. If you would like to test the library or contribute more regularly, please talk to either Conrad Haupt (@conradhaupt) or Marc Drudis (@MarcDrudis).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file asdf_qiskit-0.1.1.tar.gz.
File metadata
- Download URL: asdf_qiskit-0.1.1.tar.gz
- Upload date:
- Size: 17.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"44","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
10da4ebd02fddde093baa4b749cdbe243eecf2f21c4bf218063e3cf3779c92b6
|
|
| MD5 |
d94952e9f4e0e945c851aba9365ecf4b
|
|
| BLAKE2b-256 |
80b701cffc268227b2a71ad4a1d5528f4145b82f3fff231f7c7d0d16b75b8ab8
|
File details
Details for the file asdf_qiskit-0.1.1-py3-none-any.whl.
File metadata
- Download URL: asdf_qiskit-0.1.1-py3-none-any.whl
- Upload date:
- Size: 38.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"44","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2b74fdda9847b90d07ecd2327221fcbd741cfda7b6170fdc7eb3a794fdcf00a1
|
|
| MD5 |
7d0a61d292ce1c4a201aa57446f8a3d2
|
|
| BLAKE2b-256 |
f3f1e45e54059e84d790348d33f5ed7d9680f59ee20bfd8e757fe55b0428b12b
|
