Prepare the 0.1 Release (#72)

* docs: update installation instructions

The 0.1 release will be published to PyPI, simplifying the installation
instructions.

* meta: bump version number

* Remove deprecated TODOs

* ci: add code publishing workflow

---------

Co-authored-by: Timothée Dao <[email protected]>

Author: mrossinek

.github/workflows/publish_code.yml

@@ -0,0 +1,32 @@
+name: Publish release
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+*"
+
+jobs:
+
+  pypi:
+    name: pypi
+    runs-on: ubuntu-latest
+    needs: github
+    steps:
+      - name: Checkout tag
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref_name }}
+      - name: Install hatch
+        run: |
+          python -m pip install --upgrade pip
+          pip install hatch
+      - name: Build using hatch
+        run: |
+          hatch build
+      - name: Publish release
+        env:
+          HATCH_INDEX_REPO: https://upload.pypi.org/legacy/
+          HATCH_INDEX_USER: __token__
+          HATCH_INDEX_AUTH: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          hatch publish

README.md

@@ -16,15 +16,21 @@ footing (see `povm_toolbox.quantum_info`).
 
 ## Installation
 
+Make sure that you have the correct Python environment active, into which you
+want to install this code, before running the below.
+
 You can install this code via pip:
 ```
+pip install povm-toolbox
+```
+
+Alternatively, you can install it from source:
+```
 git clone [email protected]:qiskit-community/povm-toolbox.git
 cd povm-toolbox
-pip install .
+pip install -e .
 ```
-
-Make sure that you have the correct Python environment active, into which you
-want to install this code, before running the above.
+This performs an editable install to simplify code development.
 
 If you intend to develop on this code, you should consider reading the
 [contributing guide](CONTRIBUTING.md).

docs/index.rst

@@ -25,16 +25,28 @@ In this documentation you can find a number of resources including:
 Installation
 ------------
 
+Make sure that you have the correct Python environment active, into which you
+want to install this code, before running the below.
+
 You can install this code via pip:
 
+.. code-block:: bash
+
+   pip install povm-toolbox
+
+Alternatively, you can install it from source:
+
 .. code-block:: bash
 
    git clone [email protected]:qiskit-community/povm-toolbox.git
    cd povm-toolbox
-   pip install .
+   pip install -e .
+
+This performs an editable install to simplify code development.
+
+If you intend to develop on this code, you should consider reading the
+`contributing guide <https://github.com/qiskit-community/povm-toolbox/blob/main/CONTRIBUTING.md>`_.
 
-Make sure that you have the correct Python environment active, into which you
-want to install this code, before running the above.
 
 Citation
 --------

povm_toolbox/library/povm_implementation.py

@@ -137,11 +137,6 @@ def to_sampler_pub(
             :class:`.POVMImplementation` object itself. The metadata should contain all the
             information necessary to extract the POVM outcomes out of raw bitstrings.
         """
-        # TODO: figure out if it would be better to pass these arguments as a
-        #    ``SamplerPubLike`` object or even as a ``SamplerPub`` object.
-
-        # TODO: is it the right place to coerce the ``SamplerPub`` ? Or should
-        # just return a ``SamplerPubLike`` object that the SamplerV2 will coerce?
 
     def compose_circuits(self, circuit: QuantumCircuit) -> QuantumCircuit:
         """Compose the circuit to sample from, with the measurement circuit.

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "povm_toolbox"
-version = "0.0.0"
+version = "0.1.0"
 readme = "README.md"
 license = {file = "LICENSE.txt"}
 

releasenotes/notes/0.1/initial-release-61061fbfc329a5c1.yaml

@@ -0,0 +1,16 @@
+---
+prelude: >
+    .. note::
+      Starting with this release, this project will follow
+      `semantic versioning <https://semver.org/>`_.
+
+    This is a toolbox for working with positive operator-valued measures (POVMs).
+    It enables users to use POVMs for sampling the state of quantum circuits (see
+    also :mod:`povm_toolbox.sampler`) and compute expectation values of any
+    observable of interest (see also :mod:`povm_toolbox.post_processor`).
+    The toolbox includes a library of pre-defined POVMs (see
+    :mod:`povm_toolbox.library`) which provide ready-to-go POVM circuit definitions.
+    You can also implement your own POVM circuits by following the provided
+    interface.
+    Additionally, you can work with POVMs on a quantum-informational theoretical
+    footing (see :mod:`povm_toolbox.quantum_info`).