# c12simulator-clients
`c12simulator-clients` is a Python package with a tools that enables a user to communicate with the
C12's remote simulator whose purpose
is to simulate the operations on the real C12 quantum computer.
C12’s quantum computer is based on optimized
spin qubits. The spin qubit is realized from electrons trapped in a double quantum dot suspended on carbon
nano tubes (CNTs) embedded in a silicon nano circuit and microwave cavity. C12’s spin qubits have
high fidelity, scalability and connectivity because of the properties of the materials used to build the basics
elements of the C12 system.
## Installing
#### From the Test PyPI repository
Run the following command inside your local python environment:
`pip install -i https://test.pypi.org/simple/ c12simulator-clients`
#### From the PyPI repository
Run the following command inside your local python environment:
`pip install c12simulator-clients`
#### From the GitHub package
In order to run the package the best policy is to create the conda environment where
all the necessary packages will be installed. To do that, we need to have conda installed (if that
is not the case see <a href="https://conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation">conda installation</a>).
<ol>
<li> Clone the GitHub repository into local folder:
`git clone https://github.com/c12qe/c12simulator-clients.git`
</li>
<li> Create the conda environment with the command:
`conda env create -f environment.yml`
</li>
<li> Then activate the conda environment with:
`conda activate c12simulator-clients`
</li>
<li> And finally install the dependencies with
`poetry install`
</li>
</ol>
## Usage
<ol>
<li> <b> <u>From the command line:</u></b> </li>
The application will run a circuit given in Open QASM format. In order to do that a user has to have its
token (given by the administrator or ??? ). All this parameters can be given as a command line arguments:
`python3 main.py --qasmfile {{PATH_TO_FILE_WITH_QASM_STR}} --token {{USER_AUTH_TOKEN}}`
Additional argument `--verbose` can be added in order to see the more detailed output.
Detailed information of the command structure can be obtained using command `python3 main.py --help`
<li> <b> <u>From the installed package:</u></b> </li>
Jupyter notebooks are given on the link: <a href="https://github.com/c12qe/c12simulator-clients/docs/">notebooks</a>
</ol>
Raw data
{
"_id": null,
"home_page": "https://github.com/c12qe/c12simulator-clients",
"name": "c12simulator-clients",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "qiskit quantum c12 simulator",
"author": "C12 Quantum Electronics",
"author_email": "viktor@c12qe.com",
"download_url": "",
"platform": null,
"description": "# c12simulator-clients\n\n`c12simulator-clients` is a Python package with a tools that enables a user to communicate with the \nC12's remote simulator whose purpose\nis to simulate the operations on the real C12 quantum computer. \n\nC12\u2019s quantum computer is based on optimized\nspin qubits. The spin qubit is realized from electrons trapped in a double quantum dot suspended on carbon \nnano tubes (CNTs) embedded in a silicon nano circuit and microwave cavity. C12\u2019s spin qubits have \nhigh fidelity, scalability and connectivity because of the properties of the materials used to build the basics \nelements of the C12 system.\n\n## Installing\n\n#### From the Test PyPI repository\n\nRun the following command inside your local python environment:\n\n`pip install -i https://test.pypi.org/simple/ c12simulator-clients`\n\n#### From the PyPI repository\n\nRun the following command inside your local python environment:\n\n`pip install c12simulator-clients`\n\n#### From the GitHub package\nIn order to run the package the best policy is to create the conda environment where\nall the necessary packages will be installed. To do that, we need to have conda installed (if that\nis not the case see <a href=\"https://conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation\">conda installation</a>).\n<ol>\n<li> Clone the GitHub repository into local folder:\n\n`git clone https://github.com/c12qe/c12simulator-clients.git`\n\n</li>\n\n<li> Create the conda environment with the command:\n\n`conda env create -f environment.yml`\n</li>\n<li> Then activate the conda environment with:\n\n`conda activate c12simulator-clients`\n</li>\n<li> And finally install the dependencies with \n\n`poetry install`\n</li>\n</ol>\n\n\n## Usage\n\n<ol>\n\n<li> <b> <u>From the command line:</u></b> </li>\n\n\nThe application will run a circuit given in Open QASM format. In order to do that a user has to have its\ntoken (given by the administrator or ??? ). All this parameters can be given as a command line arguments:\n\n`python3 main.py --qasmfile {{PATH_TO_FILE_WITH_QASM_STR}} --token {{USER_AUTH_TOKEN}}`\n\nAdditional argument `--verbose` can be added in order to see the more detailed output.\n\nDetailed information of the command structure can be obtained using command `python3 main.py --help`\n\n\n<li> <b> <u>From the installed package:</u></b> </li>\n\nJupyter notebooks are given on the link: <a href=\"https://github.com/c12qe/c12simulator-clients/docs/\">notebooks</a>\n\n</ol>\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Different clients for access to the C12 simulator",
"version": "0.0.6",
"project_urls": {
"Documentation": "https://github.com/c12qe/c12simulator-clients/tree/master/docs",
"Homepage": "https://www.c12qe.com",
"Issues": "https://github.com/c12qe/c12simulator-clients/issues",
"Source code": "https://github.com/c12qe/c12simulator-clients"
},
"split_keywords": [
"qiskit",
"quantum",
"c12",
"simulator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0fa9f9fb204490d500c90d1ccd92848fdf4eb3d87c17e902427a50cc63af5f61",
"md5": "3a71c416d42295eb56ab542a3dcae4e6",
"sha256": "0e3fa04c59ae890f26a42db38d4654e58f7f6a18048a2e10af18b3b4a2e8ab27"
},
"downloads": -1,
"filename": "c12simulator_clients-0.0.6-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a71c416d42295eb56ab542a3dcae4e6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 15459,
"upload_time": "2023-10-26T13:38:23",
"upload_time_iso_8601": "2023-10-26T13:38:23.801607Z",
"url": "https://files.pythonhosted.org/packages/0f/a9/f9fb204490d500c90d1ccd92848fdf4eb3d87c17e902427a50cc63af5f61/c12simulator_clients-0.0.6-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-26 13:38:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "c12qe",
"github_project": "c12simulator-clients",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "c12simulator-clients"
}
JSON
