# c12-callisto-clients
`c12-callisto-clients` is a Python package with tools that enable a user to communicate with
C12's Callisto emulator, whose purpose is to emulate operations on C12’s quantum computer hardware.
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 a carbon nanotube embedded in a silicon nanofabricated
circuit. C12’s spin qubits have high fidelity, scalability and connectivity because of the properties
of the materials used.
## Installing
#### From the PyPI repository
Run the following command inside your local Python environment:
`pip install c12_callisto_clients`
#### From the GitHub package
In order to run the package the best policy is to create a 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 c12_callisto_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 input
a personal token that C12 can provide. All the parameters can be given as command line arguments:
`python3 main.py --qasmfile {{PATH_TO_FILE_WITH_QASM_STR}} --token {{USER_AUTH_TOKEN}}`
The additional argument `--verbose` can be added in order to see a more detailed output.
Details 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 available at: <a href="https://github.com/c12qe/c12-callisto-clients/tree/master/docs">notebooks</a>
</ol>
## Licence
Licence EULA document can be seen <a href="https://github.com/c12qe/c12-callisto-clients/blob/master/20231110_C12_EULA%20Callisto%20-%20vf.pdf"> here </a>
Raw data
{
"_id": null,
"home_page": "https://github.com/c12qe/c12simulator-clients",
"name": "c12-callisto-clients",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "qiskit quantum c12 simulator",
"author": "C12 Quantum Electronics",
"author_email": "viktor@c12qe.com",
"download_url": "https://files.pythonhosted.org/packages/2e/9f/b704a1927308a3b47442b7fc5ec7a84abd1a07f4a652fa924f14c2849e32/c12_callisto_clients-2.2.0.tar.gz",
"platform": null,
"description": "# c12-callisto-clients\n\n`c12-callisto-clients` is a Python package with tools that enable a user to communicate with \nC12's Callisto emulator, whose purpose is to emulate operations on C12\u2019s quantum computer hardware.\n\nC12\u2019s quantum computer is based on optimized spin qubits. The spin qubit is realized from electrons\ntrapped in a double quantum dot suspended on a carbon nanotube embedded in a silicon nanofabricated\ncircuit. C12\u2019s spin qubits have high fidelity, scalability and connectivity because of the properties\nof the materials used.\n\n## Installing\n\n\n#### From the PyPI repository\n\nRun the following command inside your local Python environment:\n\n`pip install c12_callisto_clients`\n\n#### From the GitHub package\nIn order to run the package the best policy is to create a 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 c12_callisto_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 input\na personal token that C12 can provide. All the parameters can be given as command line arguments:\n\n`python3 main.py --qasmfile {{PATH_TO_FILE_WITH_QASM_STR}} --token {{USER_AUTH_TOKEN}}`\n\nThe additional argument `--verbose` can be added in order to see a more detailed output.\n\nDetails 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 available at: <a href=\"https://github.com/c12qe/c12-callisto-clients/tree/master/docs\">notebooks</a>\n\n</ol>\n\n\n## Licence \n\nLicence EULA document can be seen <a href=\"https://github.com/c12qe/c12-callisto-clients/blob/master/20231110_C12_EULA%20Callisto%20-%20vf.pdf\"> here </a>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Different clients for access to the C12 simulator",
"version": "2.2.0",
"project_urls": {
"Documentation": "https://c12qe.github.io/c12-callisto-clients/",
"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": "615f6561dd2a2223d7299ef3210242616e09515e21b9dcbaa4aae1835a7dea14",
"md5": "f639fcc8d698894d4ea05dd0f492e62f",
"sha256": "252401eb1333c45870739a510109fba9200796169db0f049513d12d62c66c0ba"
},
"downloads": -1,
"filename": "c12_callisto_clients-2.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f639fcc8d698894d4ea05dd0f492e62f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 29487,
"upload_time": "2024-10-09T10:30:17",
"upload_time_iso_8601": "2024-10-09T10:30:17.426135Z",
"url": "https://files.pythonhosted.org/packages/61/5f/6561dd2a2223d7299ef3210242616e09515e21b9dcbaa4aae1835a7dea14/c12_callisto_clients-2.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2e9fb704a1927308a3b47442b7fc5ec7a84abd1a07f4a652fa924f14c2849e32",
"md5": "f73bf45256117ec33ca67c632749f796",
"sha256": "d8ece725f52831ba4300f708231a99e7e9150ea8844a45da26c51f1a32134328"
},
"downloads": -1,
"filename": "c12_callisto_clients-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "f73bf45256117ec33ca67c632749f796",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 23207,
"upload_time": "2024-10-09T10:30:19",
"upload_time_iso_8601": "2024-10-09T10:30:19.477404Z",
"url": "https://files.pythonhosted.org/packages/2e/9f/b704a1927308a3b47442b7fc5ec7a84abd1a07f4a652fa924f14c2849e32/c12_callisto_clients-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 10:30:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "c12qe",
"github_project": "c12simulator-clients",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "c12-callisto-clients"
}
JSON
