Commit c79bc8c5 authored by liang's avatar liang
Browse files

solve merge conflict with momir's OpenQubit branch and merge locally

parents e75f8ea7 52a89cf1
Pipeline #1511 failed with stage
in 27 seconds
......@@ -84,6 +84,15 @@ Pilot Projects
**LocConQubit** is a code for the construction of controlled pulses on isolated qubit systems using the Local Control Theory.
.. toctree::
:glob:
:maxdepth: 1
./modules/OpenQubit/readme
**OpenQubit** is an extension to the LocConQubit code for the construction of controlled pulses in a more realistic environment with
disipating effects.
One of primary activity of E-CAM is to engage with pilot projects with industrial partners. These projects are conceived
together with the partner and typically are to facilitate or improve the scope of computational simulation within the
partner. The related code development for the pilot projects are open source (where the licence of the underlying
......
......@@ -74,7 +74,7 @@ The schematic below illustrates the LCT procedure.
Applications of the Module
__________________________
Application of the LCT module can be found `here <https://www.e-cam2020.eu/pilot-project-ibm/>`_ .
Application of the LCT module can be found at the `pilot project web page <https://www.e-cam2020.eu/pilot-project-ibm/>`_ .
Installation
......@@ -118,7 +118,11 @@ Source Code Documentation
_________________________
The source code is accompanied with `sphinx <http://www.sphinx-doc.org/en/stable/>`_ documentation located in sub-directory *doc*.
<<<<<<< HEAD
Instractions for sphinx installation can be found `here <http://www.sphinx-doc.org/en/stable/>`_.
=======
Instractions for sphinx installation can be found `here <http://www.sphinx-doc.org/en/stable/tutorial.html#install-sphinx>`_.
>>>>>>> mmalis/E-CAM-Library-OpenQubit
The html documentation files can be obtained by executing the following command in the *doc* sub-directory
::
......
.. _OpenQubit:
####################
OpenQubit
####################
.. sidebar:: Software Technical Information
Language
Python 3.5
License
MIT license (MIT)
Documentation Tool
sphinx
.. contents:: :local:
.. This is an example of what a *module* for E-CAM looks like. Please add to this template any additional items that are
.. straightforward to fill out in the general case. You are free add any level of complexity you wish (within the bounds of
.. what ReST_ can do).
.. To add your module, fork this GitLab repository to your account on GitLab. Clone your repository, make a feature branch
.. and add a directory that will contain your module information. Copy this :download:`readme.rst` file there. Push your
.. changes back to GitLab and immediately open a merge request from your feature branch against our repository. We can
.. discuss your module in the merge request and help you get it accepted.
.. Add technical info as a sidebar and allow text below to wrap around it
Purpose of Module
_________________
OpenQubit is a patch to the *LocConQubit* module which extends the capabilities of the latter module
with functionalities to generate control pulses in a more realistic systems with dissipating effects.
The module incorporates the Lindblad master equation into the system propagator upon which the Local
Control Theory generates a control pulse. For more information on LocConQubit module and Local Control
Theory see :doc:`here<../LocConQubit/readme>` .
Applications of the Module
__________________________
Application of the OpenQubit module can be found at this link_ .
.. _link: https://www.e-cam2020.eu/pilot-project-ibm/
Installation
____________
Before applying the patch LocConQubit code has to be installed and tested.
For the installation and testing of LocConQubit code see the corresponding documentation_ .
git_ has to be also installed.
The OpenQubit patch should be downloaded from the repository_ and made available to insert it into the
directory containing the LocConQubit module.
In the directory containing the branch with the LocConQubit module the installation of the OpenQubit is
performed by applying the OpenQubit patch.
It is advise to make a new branch from the master branch first.
The installation should be made by following these instructions:
::
(Check that you are on the QC master branch,
e.g. command 'git status' should display master in output)
git checkout -b OpenLCTCode
(Download the OpenQubit.patch file here directly or
copy it from a directory containing the previous download:)
cp [Directory containing the OpenQubit.patch file]/OpenQubit.patch .
git apply OpenQubit.patch
Special care should be taken when patching the *test_5.pkl* binary file.
If the above operation fails due to problems with patching a binary file, the file can be separately
downloaded from the patch source code webpage_ and inserted into the *reference_data* subdirectory.
.. _documentation: ../LocConQubit/readme.html
.. _git: https://git-scm.com/
.. _repository: webpage_
.. _webpage: https://gitlab.e-cam2020.eu:10443/Quantum-Dynamics/QC/tree/OpenQubit
Testing
_______
The application of the OpenQubit patch should be verified by executing the
LocConQubit module standard test, which is performed by executing the below command in the
same directory containing all of the OpenQubit module files
::
python test_LCT.py
where `python` is an alias for a Python 3.5 version interpreter or higher.
The test executes five LocConQubit standard test and an additional OpenQubit test (*test_5.pkl*).
Unit tests are sequentially executed and all must pass successfully in order to use the OpenQubit module.
Source Code
___________
The OpenQubit patch is located at: https://gitlab.e-cam2020.eu:10443/Quantum-Dynamics/QC/tree/OpenQubit
This same link contains the *test_5.pkl* binary file for download.
Source Code Documentation
_________________________
The source code is accompanied with `sphinx <http://www.sphinx-doc.org/en/stable/>`_ documentation located in sub-directory *doc*.
Instractions for sphinx installation can be found `here <http://www.sphinx-doc.org/en/stable/tutorial.html#install-sphinx>`_.
The html documentation files can be obtained by executing the following command in the *doc* sub-directory
::
cd ./doc
make html
The generated documentation is located in the *./doc/_build/html/index.html*
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment