nqct 0.2.0__tar.gz

nqct-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install package
+        run: uv sync --extra dev
+
+      - name: Ruff
+        run: uv run ruff check nqct tests
+
+      - name: Mypy
+        run: uv run mypy nqct
+
+      - name: Pytest
+        run: uv run pytest tests/unit --cov=nqct --cov-report=term-missing

nqct-0.2.0/.github/workflows/deploy-docs.yaml

@@ -0,0 +1,67 @@
+name: Build and Deploy Sphinx Documentation
+
+on:
+  push:
+    branches:
+      - main  # Change this to the default branch of your repository (e.g., master or main)
+  pull_request:
+    branches:
+      - main  # Optional: deploy when a PR is made to main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Install Pandoc and LibGLU
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y pandoc
+        sudo apt-get install -y libglu1-mesa libxi6 libxrender1
+        sudo apt-get install -y python3-pyqt5
+
+    - name: Install Qt dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y \
+          libegl1 \
+          libgl1 \
+          libxkbcommon-x11-0 \
+          libxcb-cursor0 \
+          libxcb-xinerama0 \
+          libxcb-icccm4 \
+          libxcb-image0 \
+          libxcb-keysyms1 \
+          libxcb-randr0 \
+          libxcb-render-util0 \
+          libxcb-shape0 \
+          libxcb-sync1 \
+          libxcb-xfixes0
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.11'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e . 
+        pip install sphinx sphinx_rtd_theme nbsphinx
+
+    - name: Build the documentation
+      run: |
+        sphinx-build -b html doc-sphinx/source doc-sphinx/_build/html
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        publish_dir: doc-sphinx/_build/html  # Path to your built HTML docs
+        github_token: ${{ secrets.GITHUB_TOKEN }}  # Token provided automatically by GitHub
+        publish_branch: gh-pages  # The branch that will host your docs

nqct-0.2.0/.github/workflows/release.yaml

@@ -0,0 +1,53 @@
+name: Release nqct
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out release
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+
+      - name: Install build
+        run: python -m pip install --upgrade build
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Store distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/nqct
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

nqct-0.2.0/.gitignore

@@ -0,0 +1,46 @@
+# Byte-compiled / cache
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Tooling
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+dist/
+build/
+*.egg-info/
+
+# IDE / editor
+.idea/
+.vscode/
+.cursor/
+*.swp
+
+# OS
+.DS_Store
+
+# Local env (never commit secrets)
+.env
+.env.*
+
+# Agent / local scaffolding (never commit)
+.worktrees/
+.superpowers/
+docs/superpowers/
+superpowers/
+AGENTS.md
+temp/
+
+# Sphinx documentation
+doc-sphinx/build/
+doc-sphinx/source/generated/
+doc-sphinx/source/_autosummary/

nqct-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.2
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - httpx>=0.27
+          - pydantic>=2.5
+          - types-requests

nqct-0.2.0/.python-version

@@ -0,0 +1 @@
+3.12

nqct-0.2.0/CHANGELOG.md

@@ -0,0 +1,82 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- `Job.download_bundle()` / `QuantumSession.download_bundle()` for `GET /jobs/{id}/artifacts/bundle` (stream hardware result zip to a local path).
+- Walkthrough cells demonstrating hardware artifact bundle download.
+- Hardware `shot_repeat` (software repeat) on `submit_job` / `build_execution_config` / `HardwareExecutionConfig` (integer ≥ 1; omitted when unset).
+- Hardware measurement kwargs on `submit_job` / `build_execution_config`: `acquisition_type` (`Discrimination` | `Integration` | `Raw`) and `averaging` (`AverageRepetitions` | `SingleShotCounts`), with case-insensitive normalization.
+- `HardwareExecutionConfig.acquisition_type` / `.averaging` fields aligned with production `POST /jobs`.
+- `QuantumSession.set_acquisition_type` / `set_averaging_type` wired through to `submit_job`.
+- Walkthrough cell demonstrating hardware `acquisition_type` / `averaging` submit.
+- `source="pulse_designer"` on `submit_job` / `JobsManager.submit` (POST /jobs allowlist).
+- Hardware `execution_config` helpers: `qubit_mapping`, `gate_substitutions`, `readout_mapping`, `pulse_calibration_id`.
+- Pydantic models `ExecutionConfig`, `QubitMappingEntry`, and related types in `nqct.models`.
+- `Job.program`, `Job.execution_config`, and `Job.metadata` fields aligned with production `JobResponse`.
+
+### Changed
+
+- Default API URL is production `https://api.nqct.org/api/v1` when `url=` / `NQCT_URL` are unset; `save_account(api_key=...)` no longer requires `url`.
+- `examples/sdk_walkthrough.ipynb` credential setup is a single `API_KEY` cell (save + client).
+- `examples/sdk_walkthrough.ipynb` centers on direct QASM submit; function invoke section removed for now.
+- README documents production API `https://api.nqct.org/api/v1` alongside local `nqct start`.
+- README quick start leads with `submit_job`.
+- `build_execution_config()` now constructs and validates `ExecutionConfig`/`SimulatorExecutionConfig`/`HardwareExecutionConfig` (via Pydantic) instead of hand-building dicts; invalid `qubit_mapping` entries or unknown fields now raise `pydantic.ValidationError`. `qubit_mapping` accepts `dict` or `QubitMappingEntry` items.
+- `examples/sdk_walkthrough.ipynb` submit cell catches `JobFailedError`/`JobTimeoutError` around `job.wait()` and prints status + logs instead of raising.
+
+### Fixed
+
+- `SimulatorExecutionConfig`/`HardwareExecutionConfig` now reject unknown fields (`extra="forbid"`), matching `QubitMappingEntry`.
+- Package version in `pyproject.toml` aligned with changelog (`0.2.0`).
+- `HTTPSession.stream_to_path` no longer raises a spurious `DecodingError` on gzip-encoded error bodies (was double-decoding a rebuilt `httpx.Response`).
+- `HTTPSession.stream_to_path` now streams to a sibling temp file and atomically `os.replace`s it into `dest`, so a mid-download failure no longer leaves a truncated `dest` or destroys a prior good download.
+- `examples/sdk_walkthrough.ipynb` bundle-download cell now `mkdir`s the `downloads` directory before calling `download_bundle`, since a non-existent directory target is otherwise treated as the destination file itself.
+
+## [0.2.0] - 2026-07-08
+
+### Added
+
+- `JobsManager.submit()` / `NQCTClient.submit_job()` — `POST /jobs` with OpenQASM 3, `execution_config`, and `source` (`direct_qasm` | `api`).
+- `Job.booking_bypass` and `Job.source` fields aligned with Unit 07 program-centric jobs API.
+- `client.jobs(source=...)` filter parameter.
+- Example `examples/submit_job.py`.
+
+### Changed
+
+- Managed-backend circuit execution on the platform is async (`POST /circuits/submit`); use `submit_job()` instead of a sync `run_circuit()` helper (planned Phase 2).
+
+## [0.1.0] - 2026-07-03
+
+### Added
+
+- Phase 1 MVP: credentials save/load, env discovery, `BackendsManager`, `JobsManager`, `FunctionsManager`.
+- Resource models `Backend`, `Job`, `Function` with `job.wait()`, `job.result()`, `job.cancel()`, `function.invoke()`.
+- `client.backends()`, `client.backend()`, `client.least_busy()`, `client.jobs()`, `client.job()`, `client.functions()`, `client.function()`.
+- Unit tests with `respx` fixtures; integration test suite (`pytest -m integration`).
+- Example script `examples/invoke_function.py`.
+- [uv](https://docs.astral.sh/uv/) for local development and CI.
+
+### Changed
+
+- Renamed repository from `nqct-runtime` to `nqct-sdk` (GitHub URLs, docs, Cursor rules).
+- Bumped version to `0.1.0` (Phase 1 MVP).
+
+## [0.0.1] - 2026-07-01
+
+### Added
+
+- Phase 0 bootstrap: `NQCTClient`, `HTTPSession`, credentials file helpers, exception hierarchy.
+- Public aliases `Client` and `Runtime`.
+- Unit tests, ruff, mypy, pytest, pre-commit, GitHub Actions CI.
+
+[Unreleased]: https://github.com/NQCT-Australia/nqct-sdk/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/NQCT-Australia/nqct-sdk/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/NQCT-Australia/nqct-sdk/releases/tag/v0.1.0
+[0.0.1]: https://github.com/NQCT-Australia/nqct-sdk/releases/tag/v0.0.1

nqct-0.2.0/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 NQCT Australia
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute
+          must include a readable copy of the attribution notices
+          contained within such NOTICE file, excluding those notices
+          that do not pertain to any part of the Derivative Works,
+          in at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within the
+          Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing
+      the origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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.

nqct-0.2.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.5
+Name: nqct
+Version: 0.2.0
+Summary: Python SDK for the National Quantum Computing Testbed (NQCT)
+Project-URL: Homepage, https://github.com/NQCT-Australia/nqct-sdk
+Project-URL: Documentation, https://nqct-australia.github.io/nqct-sdk/
+Project-URL: Repository, https://github.com/NQCT-Australia/nqct-sdk
+Project-URL: NQCT Cloud spec, https://github.com/NQCT-Australia/nqct-cloud/blob/main/references/specs/14-python-sdk.md
+Author: NQCT Development Team
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: cloud,nqct,qiskit,quantum
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.5
+Requires-Dist: sqdtoolz
+Requires-Dist: typing-extensions>=4.8
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pre-commit>=3.8; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.30; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: nbsphinx; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme; extra == 'docs'
+Provides-Extra: notebook
+Requires-Dist: ipykernel>=6.29; extra == 'notebook'
+Requires-Dist: jupyterlab>=4.2; extra == 'notebook'
+Provides-Extra: qiskit
+Requires-Dist: qiskit-qasm3-import>=0.4; extra == 'qiskit'
+Requires-Dist: qiskit>=1.0; extra == 'qiskit'
+Description-Content-Type: text/markdown
+
+<img src="doc-sphinx/source/_static/nqct.png" width="300">
+
+-----------
+
+[![Documentation](https://img.shields.io/badge/Documentation-blue)](https://nqct-australia.github.io/nqct-sdk/)
+
+
+Python interface for the **National Quantum Computing Testbed (NQCT)**.
+
+The NQCT Python SDK lets researchers and developers work with NQCT programmatically from Python, Jupyter notebooks, scripts, and automated workflows. Use it to discover available quantum computing resources, submit work, monitor jobs, and retrieve results.
+
+The SDK provides programmatic access to the same NQCT environment available through the [NQCT Cloud portal](https://cloud.nqct.org) (see [Developer documentation](docs/README.md)).
+
+> **NQCT is an evolving platform.** We welcome feedback, bug reports, feature requests, and complaints. See [Feedback and support](#feedback-and-support) below.
+
+---
+
+## Getting started
+
+The easiest way to get started is through the example Jupyter notebooks in this repository.
+
+They are designed to take you from your first connection to NQCT through progressively more advanced workflows.
+
+**New to the SDK? Start here:**
+
+1. Get an NQCT account and API key.
+2. Install the Python SDK.
+3. Open the **Getting Started** notebook.
+4. Follow the examples and adapt them to your own work.
+5. Explore the other notebooks as you become familiar with the platform.
+
+See [Examples and notebooks](#examples-and-notebooks).
+
+---
+
+## Installation
+
+Install the SDK using Python's package manager:
+
+```bash
+pip install nqct
+```
+
+> **Note:** The package will be published to PyPI as the project reaches its public release. Until then, see the repository documentation for the current installation method.
+
+You will also need an **NQCT API key** to access the platform.
+
+API keys are managed through your NQCT account.
+
+---
+
+## Feedback and support
+
+NQCT is an active research and development platform, and **user feedback is an important part of its development**.
+
+If you encounter a problem, have a feature request, disagree with how something works, or simply have feedback about your experience, please open an issue on GitHub.
+
+**GitHub Issues are also the preferred forum for discussion and feedback.**
+
+[Open an issue or join the discussion](https://github.com/NQCT-Australia/nqct-sdk/issues).
+
+---
+
+## Related resources
+
+| Resource                                                            | Description           |
+| ------------------------------------------------------------------- | --------------------- |
+| [NQCT Cloud](https://cloud.nqct.org)                                | NQCT web portal       |
+| [NQCT Python SDK](https://github.com/NQCT-Australia/nqct-sdk)       | This repository       |
+| [NQCT Cloud platform](https://github.com/NQCT-Australia/nqct-cloud) | NQCT platform and API |
+| [NQCT API documentation](https://api.nqct.org/docs)                 | API reference         |
+
+---
+
+## Project status
+
+The NQCT Python SDK is under active development.
+
+Current functionality and interfaces may evolve as the NQCT platform develops. See the [CHANGELOG](CHANGELOG.md) for significant changes between releases.
+
+For the latest information about supported capabilities, see the example notebooks and current technical documentation.