From 919a2b21993f8aad6189885d0dcb2a4a596287e2 Mon Sep 17 00:00:00 2001
From: Edoardo Pedicillo <edoardo.pedicillo@gmail.com>
Date: Tue, 15 Oct 2024 12:44:09 +0400
Subject: [PATCH] simplify README.md

---
 README.md | 56 +++++--------------------------------------------------
 1 file changed, 5 insertions(+), 51 deletions(-)

diff --git a/README.md b/README.md
index 76ac2ca..c0c4827 100644
--- a/README.md
+++ b/README.md
@@ -3,12 +3,12 @@
 <img src="figures/diagram.png" style="solid #000; max-width:600px; max-height:1000px;">
 Boosting variational eigenstate preparation algorithms limited by training and not device coherence by diagonalization double-bracket iteration.
 
-## Setup
+## Installation instructions
 
-Given you have `poetry` installed
+The package can be installed by source after cloning the repository:
 
 ```sh
-poetry install && poetry shell
+pip install -e .
 ```
 
 will install `boostvqe 0.0.1` and activate a dedicated working shell.
@@ -26,58 +26,12 @@ The source code is located in `./src/boostvqe/.` and its composed of:
 
 ## How to run the code
 
+For further information about the inputs:
+
 ```sh
 python main.py --help
 ```
 
-```sh
-
-usage: main.py [-h] [--backend BACKEND] [--platform PLATFORM]
-               [--nthreads NTHREADS] [--optimizer OPTIMIZER]
-               [--optimizer_options OPTIMIZER_OPTIONS] [--tol TOL]
-               [--decay_rate_lr DECAY_RATE_LR] [--nqubits NQUBITS]
-               [--nlayers NLAYERS] [--output_folder OUTPUT_FOLDER]
-               [--nboost NBOOST] [--boost_frequency BOOST_FREQUENCY]
-               [--dbi_steps DBI_STEPS] [--stepsize STEPSIZE]
-               [--optimize_dbi_step OPTIMIZE_DBI_STEP]
-               [--store_h | --no-store_h] [--hamiltonian HAMILTONIAN]
-               [--seed SEED] [--nshots NSHOTS]
-
-VQE with DBI training hyper-parameters.
-
-optional arguments:
-  -h, --help            show this help message and exit
-  --backend BACKEND     Qibo backend
-  --platform PLATFORM   Qibo platform (used to run on GPU)
-  --nthreads NTHREADS   Number of threads used by the script.
-  --optimizer OPTIMIZER
-                        Optimizer used by VQE
-  --optimizer_options OPTIMIZER_OPTIONS
-                        Options to customize the optimizer training
-  --tol TOL             Absolute precision to stop VQE training
-  --decay_rate_lr DECAY_RATE_LR
-                        Decay factor of the learning rate if sgd is used
-  --nqubits NQUBITS     Number of qubits for Hamiltonian / VQE
-  --nlayers NLAYERS     Number of layers for VQE
-  --output_folder OUTPUT_FOLDER
-                        Folder where data will be stored
-  --nboost NBOOST       Number of times the DBI is used in the new
-                        optimization routine. If 1, no optimization is run.
-  --boost_frequency BOOST_FREQUENCY
-                        Number of optimization steps which separate two DBI
-                        boosting calls.
-  --dbi_steps DBI_STEPS
-                        Number of DBI iterations every time the DBI is called.
-  --stepsize STEPSIZE   DBI step size.
-  --optimize_dbi_step OPTIMIZE_DBI_STEP
-                        Set to True to hyperoptimize the DBI step size.
-  --store_h, --no-store_h
-                        H is stored for each iteration
-  --hamiltonian HAMILTONIAN
-                        Hamiltonian available in qibo.hamiltonians.
-  --seed SEED           Random seed
-  --nshots NSHOTS       number of shots
-```
 # Tutorials
 
 Some useful notebooks to understand how the library works, are collected [here](notebooks/notebooks_links.md).