• This repository has been archived on 22/Feb/2024
  • Stars
    star
    143
  • Rank 257,007 (Top 6 %)
  • Language
    Shell
  • Created over 4 years ago
  • Updated 9 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Home of Qiskit documentation translations

Image

⚠️ This repository is not a package.: The setup.py file is only in this repository as a requirement for building docs. If you'd like to install Qiskit, follow the link.

Qiskit Documentation Localization Crowdin

First of all, thank you for showing interest in translating (localizing) Qiskit Documentation! This helps make the documentation more accessible and available to our global community.

👀 Please note that you must sign up separately if you want to join the localization project for Qiskit Textbook. For signing up to join the Qiskit Textbook Localization project, please refer the steps outlined here.

If you are interested in contributing to Qiskit Documentation translations, please follow the instructions below.

To sign up to participate in translations:

  1. Open the LOCALIZATION_CONTRIBUTORS file. Look for the language header that you'd like to contribute to and sign up under there. If you do not find the language that you'd like to contribute to, please read this section.

  2. Create a pull request (PR) to add your name to the list. Make sure to follow the template to open a Pull Request.

    • Each contributor has to create their own PR and sign the CLA (see #3 below).
    • If you have an open issue for a language request, add the issue link to the PR.

    (Not sure how to open a PR? Checkout this section)

  3. When you conribute to a Qiskit open source project on GitHub with a new pull request, a bot will evaluate whether you have signed the Qiskit Contribution License Agreement (CLA). If it is your first time contributing to Qiskit, you will be prompted to sign the CLA in your PR. Please make sure to sign the CLA by accepting the agreement.

  4. In the Qiskit-Docs Crowdin project, choose the language that you want to contribute to.

  5. Click the Join button and paste the URL of your PR in the dialog box where you are asked why you want to join the Crowdin project. request_crowdin Failing to do so will result in a delay in approving your request in Crowdin and your Pull Request in GitHub. The administrators of the Crowdin project will review your request and give you access as quickly as they can.

  6. For questions regarding onboarding or strategy, to connect with other translators and receive updates regarding the project please join #qiskit-localization channel in the Qiskit workspace or make an issue in this repo.

What is Crowdin?

Qiskit documentation is translated (localized) using Crowdin, a software and web localization platform that allows organizations to coordinate translation projects and collaborate with communities to translate materials. Crowdin allows our community of translators to amplify their impact by automatically reusing the work invested in translating one sentence, to translate other, similar sentences. Crowdin also makes translations resilient to many types of changes to the original material, such as moving sentences around, even across files.

How to add a new language to translate?

The list of languages that Qiskit Documentation Localization Project currently supports can be seen in the Crowdin project page. These translations can be viewed from our staging site.

Japanese, German, Korean, Portuguese, French and Tamil documentation are now available in the Qiskit Documentation website.

The Machine Learning application tutorials are available in Bengali, French, Hindi, Japanese, Korean, Malayalam, Russian, Spanish, Tamil, Turkish

As mentioned in the blog post Qiskit in my language is Qiskit, we want to make sure that translated languages have enough community support to ensure quality and consistency.

If you want to add a new language and become a translation lead, you can open a GitHub issue to start a discussion with the Qiskit team and recruit translation project members. Please refer to the criteria below to receive official support from the administrators for new languages.

🆕What is the criteria for adding a new language?

  1. A minimum of five contributors is necessary for any new languages to be added and receive official support from the administrators of the localization project.
  2. One of the contributors in that language must be a Qiskit Advocate and should actively participate.
  3. In addition to translators, we will need dedicated proof-readers to review the translations and approve accuracy of content in that language and to ensure that the translations can be released in that language.
  4. Among the group of contributors, a translation lead must be identified to serve as a liaison with the administrators of the localization project. The lead must contact Soolu Thomas and Yuri Kobayashi by email containing the issue number (or link) and, a little intro about the TL(s) and the team after the above three criteria are met.
  5. The project administrators will schedule a meeting with the translation lead(s) of the proposed language. Please note that satisfying the minimum number of translators does not automatically make the language ready to be added to Crowdin. It will be very important for the team to make continuous progress and to be active.

These are general guidelines for joining translation efforts and adding new languages. If you have further questions, please feel free to contact Soolu Thomas and Yuri Kobayashi. Thank you.

How to add my name to LOCALIZATION_CONTRIBUTORS list and open a PR in GitHub?

Option 1: In Github (Recommended)

  1. Click on the pen-like button which says "Edit this file" in the LOCALIZATION_CONTRIBUTORS file.
  2. Add your name under the language you'd like to contribute to.
  3. Once your name is added, scroll down and find a green button which says "Propose changes".
  4. The page now reloads automatically and find and click on another green button - "Create pull request".
  5. This should create the pull request and once that's done, follow the instructions (step 3, 4, 5).

Option 2: Creating a local clone of the repository and pushing from local

  1. Clone this repository by following this guide.
  2. Make sure your local git configuration by following the instructions here -- Setting username and Setting email
  3. Create a branch by running git checkout -b BRANCH_NAME in your terminal.
  4. Find LOCALIZATION_CONTRIBUTORS file in your local copy of qiskit-translations (created after cloning this repository) and add your name under the language you'd like to contribute to.
  5. Now, in the terminal run git add LOCALIZATION_CONTRIBUTORS, git commit -m "Added name under LANGUAGE-NAME", git push origin BRANCH-NAME.
  6. Follow the link in the terminal to open a pull request.

Digital Badges

At Qiskit, we feel that it is important to recognize the contributions that were made by its members to make our documentation more accessible to the global community. Starting in 2020, localization contributors who drove efforts in translating, proof-reading and managing progress can earn a Qiskit Localization Contributor Badge. For details, please refer to Qiskit Localization Digital Badges.

When you find an issue in the original documentation

During the process of translating Qiskit documentation, you may identify errors (mostly typos) in the original documentation. Please feel free to suggest corrections by opening an issue and choose Documentation.

Project Leads

Name Slack (Qiskit Workspace)
Yuri Kobayashi @Yuri Kobayashi
Sophy Shin @Sophy
Soolu Thomas @Soolu
Claudia Zendejas-Morales @clausia

Translation Leads

Language Translation Leads Slack (Qiskit Workspace)
Bengali Abhijit Mitra, Sristy Sangskriti @amitracal @Sristy Sangskriti
Chinese Simplified Helena Zhang, Wen-Sen Lu @Helena Zhang @Wen-Sen (Vince)
Chinese Traditional Helena Zhang, Wen-Sen Lu @Helena Zhang @Wen-Sen (Vince)
French Jean-Michel Torres @torresjm
German Thorsten Muehge @Thorsten Mühge
Gujarati Komal Pandya @Komal Pandya
Hindi Samanvay Sharma, Guncha Malik @sam @Guncha Malik
Japanese Takehiko Amano @Takehiko Amano
Korean Soyoung Shin, Mingi Ryu @Sophy @Mingi
Marathi Amol Deshmukh @Amol Deshmukh
Polish Piotr Biskupski @pb.worker
Portuguese (United) Luiz Henrique Galeoti de Lima, Omar Costa Hamido @Luiz Galeoti @OCH
Russian Vasily Shcherbinin, Farida Shagieva @Vasily Shcherbinin @Farida
Spanish (United) Claudia Zendejas-Morales, Rodrigo Rosado Rivial @clausia @rodrigo rosado
Tamil Manjula Gandhi @Manjula Gandhi
Telugu Gayatri Vadaparty, Surya Sai Teja Desu @Gayatri @Surya Sai Teja
Thai Tanapat Deesuwan, Ruchipas Bavontaweepanya, Natchapol Patamawisut @Tanapat @Ruchipas Bavontaweepanya @Bank Patamawisut
Turkish Ayşin Sancı @ayshine

(Last updated on May 31, 2023)

More Repositories

1

qiskit-community-tutorials

A collection of Jupyter notebooks developed by the community showing how to use Qiskit
Jupyter Notebook
710
star
2

qiskit-machine-learning

Quantum Machine Learning
Python
668
star
3

qiskit-aqua

Quantum Algorithms & Applications (**DEPRECATED** since April 2021 - see readme for more info)
Python
572
star
4

qiskit-nature

Qiskit Nature is an open-source, quantum computing, framework for solving quantum mechanical natural science problems.
Python
301
star
5

qiskit-metal

Quantum Hardware Design. Open-source project for engineers and scientists to design superconducting quantum devices with ease.
Python
288
star
6

IBMQuantumChallenge2020

Quantum Challenge problem sets
Jupyter Notebook
252
star
7

qiskit-finance

Quantum Finance
Python
237
star
8

qiskit-optimization

Quantum Optimization
Python
228
star
9

qiskit-ignis

Ignis (deprecated) provides tools for quantum hardware verification, noise characterization, and error correction.
Python
168
star
10

ibm-quantum-challenge-2024

For IBM Quantum Challenge 2024 (5-14 June 2024)
Jupyter Notebook
159
star
11

qiskit-experiments

Qiskit Experiments
Python
156
star
12

ibm-quantum-challenge-2021

For IBM Quantum Challenge 2021 (May 20 - 26)
Jupyter Notebook
155
star
13

ibm-quantum-challenge-spring-2023

For IBM Quantum Challenge Spring 2023
Jupyter Notebook
150
star
14

ibm-quantum-challenge-fall-2021

For IBM Quantum Challenge Fall 2021
Jupyter Notebook
139
star
15

may4_challenge_exercises

Original versions of the exercises
Jupyter Notebook
121
star
16

ibm-quantum-challenge-fall-22

For IBM Quantum Fall Challenge 2022
Jupyter Notebook
120
star
17

qiskit-algorithms

A library of quantum algorithms for Qiskit.
Python
115
star
18

qiskit-js

⚛️ Qiskit (Quantum Information Science Kit) for JavaScript
JavaScript
114
star
19

qiskit-dynamics

Tools for building and solving models of quantum systems in Qiskit
Python
103
star
20

ibm-quantum-spring-challenge-2022

Jupyter Notebook
98
star
21

qgss-2023

All things Qiskit Global Summer School 2023: Theory to Implementation - Lecture notes, Labs and Solutions
Jupyter Notebook
97
star
22

open-science-prize-2021

Jupyter Notebook
84
star
23

quantum-explorers

A self-paced, quantum computing learning journey for high school students and above.
Jupyter Notebook
83
star
24

qiskit-qec

Qiskit quantum error correction framework
Python
81
star
25

qiskit-presentations

Awesome Qiskit presentations
Jupyter Notebook
79
star
26

qgss-2024

Qiskit Global Summer School 2024: The Path to Utility
Jupyter Notebook
74
star
27

qiskit-research

Research using Qiskit.
Python
67
star
28

open-science-prize-2022

Jupyter Notebook
67
star
29

qiskit-braket-provider

Qiskit-Braket provider to execute Qiskit programs on quantum computing hardware devices through Amazon Braket.
Python
58
star
30

mapomatic

Automatic mapping of compiled circuits to low-noise sub-graphs
Python
56
star
31

qiskit-application-modules-demo-sessions

Demo notebooks for Qiskit application modules demo sessions (Oct 8 & 15):
Jupyter Notebook
49
star
32

ibm-quantum-challenge-africa-2021

For IBM Quantum Challenge Africa 2021, 9 September (07:00 UTC) - 20 September (23:00 UTC).
Jupyter Notebook
49
star
33

Quantum-Challenge-Grader

Grading client for the IBM Quantum Challenges
Python
44
star
34

open-science-prize

Jupyter Notebook
42
star
35

qiskit-ionq

Qiskit provider for IonQ backends
Python
42
star
36

MicroQiskit

Jupyter Notebook
42
star
37

ICPC-Quantum-Challenge-2021

Original version of the exercises for the 2021 ICPC Quantum Computing Challenge
Jupyter Notebook
41
star
38

intro-to-quantum-computing-and-quantum-hardware

intro-to-quantum-computing-and-quantum-hardware
41
star
39

quantum-prototype-template

A template repository for generating new quantum prototypes based on Qiskit
Python
41
star
40

prototype-quantum-kernel-training

Toolkit for training quantum kernels in machine learning applications
Python
40
star
41

qiskit-swift

Qiskit in swift
Swift
39
star
42

lindbladmpo

A matrix-product-operators solver for the dynamics of interacting qubits modeled by a Lindblad master equation, written in C++ and wrapped with an easy-to-use Python interface.
Python
36
star
43

qiskit-hackathon-korea-22

Jupyter Notebook
35
star
44

qiskit-hackathon-korea-21

A repository for Qiskit Hackathon Korea (February 16-19, 2021)
33
star
45

qiskit-hackathon-taiwan-20

32
star
46

qiskit-cold-atom

Tools to control cold-atom-based quantum simulators and quantum computers.
Python
31
star
47

povm-toolbox

A toolbox for the implementation of positive operator-valued measures (POVMs).
Python
30
star
48

prototype-entanglement-forging

A module for simulating chemical and physical systems using a Variational Quantum Eigensolver (VQE) enhanced by Entanglement Forging.
Python
29
star
49

prototype-zne

Zero Noise Extrapolation (ZNE) prototype for error mitigation on the Qiskit Estimator primitive
Python
28
star
50

QuantumBlur

Jupyter Notebook
27
star
51

qiskit-aqt-provider

Qiskit provider for AQT backends.
Python
27
star
52

prototype-qrao

Quantum random access optimization prototype
Python
27
star
53

qiskit-dell-runtime

Qiskit Dell Runtime is a Qiskit Runtime platform that can execute classical-quantum code on both local and on-premise environments. With this platform, hybrid classical-quantum code bundle can be developed and executed. Powered by Qiskit Runtime API, this execution model provides close-integration of classical and quantum execution.
Python
27
star
54

QuantumGraph

Jupyter Notebook
26
star
55

qiskit-app-benchmarks

Qiskit Application Benchmarks
Python
25
star
56

qiskit-qcgpu-provider

A provider which allows Qiskit to use the QCGPU simulator
Python
25
star
57

qopt-best-practices

A collection of guidelines to run quantum optimization algorithms on superconducting qubits with Qiskit, using as reference the Quantum Approximate Optimization Algorithm (QAOA) workflow.
Jupyter Notebook
25
star
58

qiskit-pocket-guide

Code from the Qiskit Pocket Guide book
Jupyter Notebook
23
star
59

ffsim

Faster simulations of fermionic quantum circuits.
Python
22
star
60

qiskit-quantinuum-provider

Qiskit provider for Quantinuum backends.
Python
21
star
61

ml-qem

Library for solving quantum computing problems using machine learning
Python
20
star
62

awesome-qiskit

Awesome Qiskit is a list of projects, tools, utilities, libraries and tutorials from a broad community of developers and researchers.
Python
20
star
63

openshift-quantum-operators

Jupyter Notebook
19
star
64

qiskit-camp-europe-19

18
star
65

qiskit-jku-provider

A local provider which allows Qiskit to use a decision-diagrams quantum simulator from JKU
C++
18
star
66

qiskit-nature-pyscf

Documentation at https://qiskit-community.github.io/qiskit-nature-pyscf/
Python
18
star
67

subgraph-isomorphism

A quantum algorithm for the subgraph isomorphism problem
Python
17
star
68

monodromy

Computations in the monodromy polytope for quantum gate sets
Python
17
star
69

qiskit-qubit-reuse

A Qiskit transpiler stage plugin to enable qubit reuse via mid-circuit measurement and reset.
Python
17
star
70

qiskit_rng

Quantum random number generator with CQC extractor
Python
16
star
71

korean-community

Jupyter Notebook
16
star
72

qiskit-aqua-interfaces

qiskit-aqua-interfaces provides command-line and graphical interfaces for executing experiments using Qiskit Aqua.
Python
16
star
73

qiskit-camp-africa-19

Qiskit Camp Africa - December 11-14, 2019
15
star
74

qiskit-alt

High-performance Qiskit features backed by Julia. A Python front end to algorithms using Pauli and Fermionic operators implemented in Julia.
Python
13
star
75

qiskit-summer-jam-20

12
star
76

quantum-algorithms-benchmarks

Jupyter Notebook
12
star
77

qiskit-hackathon-singapore-19

11
star
78

community.qiskit.org

Home of the Qiskit Community
HTML
11
star
79

qiskit-hackathon-bilbao-19

Main repository for the Quantum Hackathon in Bilbao
10
star
80

quantum-fridays

Jupyter Notebook
10
star
81

repo-monitor

Python
9
star
82

mzm-phase-boundary

This repository contains the code and data from the manuscript "Simulating spectroscopic detection of Majorana zero modes with a superconducting quantum computer."
Jupyter Notebook
9
star
83

qiskit-benchmarks

A performance comparinson of Qiskit contributions
Python
8
star
84

QCHack-2022

8
star
85

qiskit.camp

Qiskit.camp 19 - Bringing together the Qiskit community
CSS
8
star
86

may4_challenge

Happy birthday IQX
Python
7
star
87

dsm-swap

A doubly stochastic matrices-based approach to optimal qubit routing
Python
7
star
88

Qiskit-runtime-primitives-with-MATLAB

Qiskit Runtime Primitives through Matlab
MATLAB
7
star
89

arraylias

A Python library for automatic aliasing of multiple array libraries
Python
7
star
90

qiskit-toqm

Qiskit Terra transpiler passes for the Time-Optimal Qubit Mapping (TOQM) algorithm.
Python
7
star
91

Qiskit-Hackathon-at-World-of-QUANTUM

Jupyter Notebook
6
star
92

quantum-hackathon-korea-22

6
star
93

archiver4qiskit

Tools to help record data from Qiskit jobs
Python
5
star
94

qiskit-quimb

Simulate Qiskit circuits using quimb.
Python
5
star
95

qiskit-nature-psi4

Python
5
star
96

QiskitUnityAsset

Qiskit Unity Asset official repository
C#
5
star
97

qiskit-translations-staging

Home of Staging Site of Qiskit Documentation Translations
5
star
98

qiskit-vue

Qiskit components library for Vue.
HTML
5
star
99

Qiskit-Resources

A curated list of all the Qiskit Resources in a single place
5
star
100

qiskit-bip-mapper

Qiskit transpiler plugin for BIP Mapping routing pass
Python
5
star