deploy: 93e4c04

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 018a3d69fd0e952b1fc510d5988fcf34
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/getting_started.rst.txt

@@ -0,0 +1,59 @@
+Getting Started
+================
+
+Setup
+-----
+
+Begin by creating a new Python environment or activating an existing one for working with the `piQture` library. You set up a Python virtual environment `venv` or a Conda environment and use `pip` or `conda` to install the `piQture` package.
+
+Here's how you can create a conda environment and manage a Python environment:
+
+.. code:: sh
+
+    # Create a new conda environment
+    conda create -n piqture_env python=3.x
+
+    # Activate the conda environment
+    conda activate piqture_env
+
+Installation
+------------
+
+Once the Python environment is activated, the required `piQture` package can be installed using `pip`. You can install the latest version directly from PyPI.
+
+.. code:: sh
+
+    pip install piqture
+
+To create a development environment, and install `piQture` from source, you can refer to section :ref:`Install from Source <installation_from_source>`.
+
+.. _installation_from_source:
+Installation from Source
+------------------------
+
+To set up a development environment and install `piQture` from source, follow these steps:
+
+1. Start by cloning the `piQture` repository from GitHub.
+
+.. code:: sh
+
+    # Clone the GitHub repository.
+    git clone https://github.com/SaashaJoshi/piQture.git
+
+
+2. Activate the Python environment and navigate to the `piQture` repository directory. Then, inside the Python environment, install the required dependencies from the `requirements.txt` configuration file.
+
+.. code:: sh
+
+    # Install the required dependencies
+    pip install -r requirements.txt
+
+
+3. Install `piQture` in editable mode to make changes to the source code.
+
+.. code:: sh
+
+    # Install from source in editable mode
+    pip install -e .
+
+Your development environment is set up, and `piQture` is installed from source. You can now start making changes to the code, running tests, and contributing to the project as a developer.

_sources/index.rst.txt

@@ -0,0 +1,39 @@
+.. piQture documentation master file, created by
+   sphinx-quickstart on Wed Apr 24 19:35:42 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to piQture's documentation!
+===================================
+
+**piQture** is a Python toolkit designed to simplify the development, execution, and training of Quantum Machine Learning (QML) models tailored for image processing tasks. This library seamlessly integrates with the Qiskit SDK, providing a convenient and user-friendly workflow for leveraging the potential of quantum computing for advanced image processing.
+
+
+Contribution Guidelines
+-----------------------
+
+We welcome contributions! Whether you're a quantum enthusiast or a Python developer, your input is valuable. Check out our Contribution Guidelines to get started.
+
+Authors and Citation
+--------------------
+
+Saasha Joshi
+
+Table of Contents
+------------------
+
+.. toctree::
+   :maxdepth: 2
+
+   getting_started
+
+.. hidden::
+   Next
+   ==================
+
+   `Getting Started <getting_started.html>`_
+
+.. hidden::
+   * :ref:`genindex`
+   * :ref:`modindex`
+   * :ref:`search`