shanqar

ShaNQar (Simulator of Network Quantique) is a photonic quantum network simulator.

https://github.com/andy-joy-25/shanqar

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.7%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

ShaNQar (Simulator of Network Quantique) is a photonic quantum network simulator.

Basic Info
  • Host: GitHub
  • Owner: andy-joy-25
  • Language: Python
  • Default Branch: main
  • Size: 68.4 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme Citation

README.md

image

ShaNQar: Simulator of Network Quantique

ShaNQar (Simulator of Network Quantique) is a modular and customizable photonic quantum network simulator.

Installation

Please ensure that you have a Python version of 3.10 or later installed in your computer. If you don't have it installed already, please download it from the official Python website.

After that is done, please clone this repo and install the necessary requirements by copy-pasting the following code in your terminal: git clone https://github.com/andy-joy-25/ShaNQar.git cd ShaNQar pip install -r requirements.txt

Running Tests

Certain expected results are only observed on average since the working of the components is inherently probabilistic in the quantum mechanical regime. To verify and validate that the elements of ShaNQar's hardware stack are working correctly, please run our rigorous test suite by copy-pasting the following code in your terminal: pytest -W ignore

Simulation Examples

To run the simulations for Quantum Key Distribution (QKD), please copy-paste the following code in your terminal: python -m src.qkd.BB84

To run the simulations for Quantum Teleportation (QT), please copy-paste the following code in your terminal: python -m src.qt.QT

Citation

Please cite us:

@software{Choudhary_ShaNQar_Simulator_of_2024, author = {Choudhary, Anand and Wasan, Ajay}, month = jul, title = {{ShaNQar: Simulator of Network Quantique}}, url = {https://github.com/andy-joy-25/ShaNQar}, version = {1.0.0}, year = {2024} }

Owner

  • Name: Anand Choudhary
  • Login: andy-joy-25
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as follows:"
authors:
- family-names: "Choudhary"
  given-names: "Anand"
- family-names: "Wasan"
  given-names: "Ajay"
title: "ShaNQar: Simulator of Network Quantique"
version: 1.0.0
date-released: 2024-07-20
url: "https://github.com/andy-joy-25/ShaNQar"

GitHub Events

Total
  • Watch event: 1
  • Push event: 1
Last Year
  • Watch event: 1
  • Push event: 1

Dependencies

requirements.txt pypi
  • iteration-utilities ==0.11.0
  • numpy ==1.23.5
  • pytest ==7.1.2
  • scipy ==1.10.0
  • simpy ==4.0.1