Skip to content

Commit

Permalink
Re-organize the files into subfolders as per Qibo doc convention
Browse files Browse the repository at this point in the history
  • Loading branch information
yangliwei committed Mar 1, 2024
1 parent b65a4d1 commit 6a20fa9
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 2 deletions.
11 changes: 11 additions & 0 deletions docs/source/getting-started/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Getting started
===============

In this section we present the basic aspects of the Qibotn design and provide installation instructions.
Please visit the following sections to understand how ``qibotn`` works.

.. toctree::
:maxdepth: 1

installation
quickstart
10 changes: 10 additions & 0 deletions docs/source/getting-started/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Installation instructions
=========================

QiboTN can be installed directly from the source repository on Github:

.. code-block::
git clone https://github.com/qiboteam/qibotn.git
cd qibotn
poetry install
51 changes: 51 additions & 0 deletions docs/source/getting-started/quickstart.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
Quick start
===========

Setting the backend
"""""""""""""""""""
QiboTN supports two backends cutensornet (using CuQuantum library) and Quimbbackend (using Quimb library) for tensor network based simulations. The backend can be set using the following command line.

For CuQuantum library,

.. testcode::
qibo.set_backend(backend="qibotn", platform="cutensornet", runcard=computation_settings)
..
and for Quimb library

.. testcode::
qibo.set_backend(
backend="qibotn", platform="QuimbBackend", runcard=computation_settings
)
..
Setting the runcard
""""""""""""""""""""
Basic structure of runcard is

.. testcode::
computation_settings = {
"MPI_enabled": False,
"MPS_enabled": False,
"NCCL_enabled": False,
"expectation_enabled": {
"pauli_string_pattern": "IXZ",
},
}
..
Basic example
""""""""""""
.. testcode::
# Construct the circuit
c = Circuit(2)
# Add some gates
c.add(gates.H(0))
c.add(gates.H(1))

# Execute the circuit and obtain the final state
result = c()

print(result.state())

..
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Contents
.. toctree::
:maxdepth: 2
:caption: Introduction
Installation
Quickstart

getting-started/index

.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit 6a20fa9

Please sign in to comment.