qiskit / qiskit.org

The Qiskit official website

Important

This repository is unmaintained and the content in qiskit.org has been superseded by the IBM Quantum | Community page. These source files are no longer maintained and may contain omissions or outdated information. Contributions to this repo are no longer accepted.

Welcome to Qiskit.org

Qiskit is an open-source quantum computing software development framework for leveraging today's quantum processors in research, education, and business.

Home page · Events · Advocates · Documentation

Table of Contents

• Table of Contents
• 🚀 Get Up and Running
• 💻 Technology Used
• 🏭 Content Generation
  • 🥸 Mocking content
• 🏷️ Naming Conventions
  • Nuxt Components
• ✏️ How to Contribute
• 🔗 Connect with Qiskit

🚀 Get Up and Running

1. Download this repository and go to its folder

   git clone [email protected]:Qiskit/qiskit.org.git && cd qiskit.org

2. Install dependencies

    npm install

3. Create an .env file

cp .env.example .env

4. Run a local server with hot reload at localhost:3000

   npm run dev

💻 Technology Used

Qiskit.org is a static website generated using Nuxt.

We create and run tests using Vitest, avoid syntax errors using ESLint and Stylelint, and automate code integration and deployment using GitHub Actions.

🏭 Content Generation

Qiskit.org integrates with the tools used by the IBM Quantum Community Team to generate content based on 3rd party APIs such as Airtable. Part of this content is prefetched during building time.

During local development, mock data is generated by default but fetching real data from Airtable is possible. If you need to do this, please ask a core maintainer for the AIRTABLE_ACCESS_TOKEN, or generate your own if you have an Airtable account with access to the required bases. Once you have the Airtable access token, change these environment variables in your .env file:

• AIRTABLE_ACCESS_TOKEN=<Airtable access token>
• GENERATE_CONTENT=true
• MOCK_CONTENT=false

Then you can run the local server as usual and the content will be fetched at the beginning:

npm run dev

🥸 Mocking content

If you don't have access to the Airtable data or you don't need to fetch it, mock data can be generated by setting the environment variable MOCK_CONTENT to true in your .env file. This is set by default after you generate your .env file from .env.example.

The project has a default mocked content under the hooks/mock/content folder. If you want your own custom mocked content, you can create a new folder and set it as your mocked content folder using the environment variable MOCK_BASE_PATH which should be an absolute path of your system.

🏷️ Naming Conventions

Nuxt Components

When working with files in the components/ directory, please adhere to the following naming conventions:

• Component files and directories should be named using PascalCase.
• Always use multi-word names.
• Simplify component names where possible, for example, EventsItemCard can be named EventsCard.
• Group related components in folders when more than one component refers to the same concept.
• When naming the component .vue files, include the whole path to make it easier to locate the components.
• Generic components that can be reused across multiple pages should be placed in the components/Ui/ directory.
• Components specific to a page should be placed in their respective directory, such as components/Events/ for events-specific components.
• Avoid appending "Section" to component names, as it is usually implied that the component represents a section of the page.

✏️ How to Contribute

Contributions are always welcomed, no matter how large or small. Before contributing, please read the contributing guide and code of conduct.

🔗 Connect with Qiskit

• Twitter
• Medium
• YouTube
• Slack

qiskit.org's Issues

Remove Community tab from the header

We want to remove the tab labelled as "Community" from the qiskit.org page.

Please @CatherineKlauss, can you confirm this?

On terra and aer can we remove the pypi

Since we are moving the users to pip install qiskit lets remove this from the elements

Implement Segment + Amplitude for analytics

clicking on "Documentation" makes the header tabs change

Update AQUAChemistry to AquaChemistry after v0.2.1

Reference: #42 (review)

qiskit.org/src/components/page-aqua.js

Lines 271 to 299 in f3feae3

	from qiskit_aqua_chemistry import AQUAChemistry
	aqua_chemistry_dict = {
	"driver": { "name": "PYSCF" },
	"PYSCF": { "atom": "", "basis": "sto3g" },
	"operator": {
	"name": "hamiltonian",
	"qubit_mapping": "parity",
	"two_qubit_reduction": True,
	"freeze_core": True,
	"orbital_reduction": [-3, -2]
	},
	"algorithm": { "name": "VQE" },
	"optimizer": { "name": "COBYLA", "maxiter": 10000 },
	"variational_form": { "name": "UCCSD" },
	"initial_state": { "name": "HartreeFock" }
	}
	molecule = "H .0 .0 -{0}; Li .0 .0 {0}"
	pts = [x * 0.1 for x in range(6, 20)]
	pts += [x * 0.25 for x in range(8, 16)]
	pts += [4.0]
	energies = np.empty(len(pts))
	distances = np.empty(len(pts))
	dipoles = np.empty(len(pts))
	for i, d in enumerate(pts):
	aqua_chemistry_dict["PYSCF"]["atom"] = molecule.format(d/2)
	solver = AQUAChemistry()

The documentation link on qiskit.org currently leads to an error

https://qiskit.org/documentation/ leads to a page that says "Sorry, that page doesn't exist!"

Slack invitation in qiskit.org is no longer active

This is the Qiskit/qiskit.org version of the issue Qiskit/qiskit#1237.

improve Ignis example style

Remove extra spaces in the example line:

from qiskit.ignis.verification.randomized_benchmarking import randomized_benchmarking_seq, RBFitter

Update the qiskit install for chemistry

This should say pip install qiskit-chemistry

Pull chemisty out of aqua

Can we make it so that the chemistry is a tab at the top.

Think of it as Qiskit | elements | components | tutorial | documentation | tools | fun.

The elements are terra, aer, aqua, ignis. I would make this a pull down
The components are chemistry, providers, (more to come).

The tools are (vscode, gui)
So in the tools i think we need submenus for vscode, chemistry gui, ...

Where can I find key for qiskit quantum gates?

the only gates I saw in youtube are Hadamart and CNOT
when:
q = QuantumRegister(2)
c = ClassicalRegister(2)
qc = QuantumCircuit(q,c)
#hadamart
qc.h(q[0])
#CNOT
qc.cx(q[0],q[1])

I want to know how to write the gate U3=U3(theta,lambada,gama) in qiskit language
but I only find it on the Internet in Qasm language as: u3(theta,lambada,gama) iv`e tried it on qiskit but there is always error messege when I try to run the program.

update link to qiskit-core github repository

On https://qiskit.org the link to the GitHub repo under latest version still points to
https://github.com/QISKit/qiskit-sdk-py
should be qiskit-core now

a link to the FAQ.

We would like have a link to both FAQ on the landing page somewhere.

Quantum Computing FAQ https://quantumexperience.ng.bluemix.net/qx/tutorial?sectionId=full-user-guide&page=000-FAQ~2F000-Frequently_Asked_Questions

Quantum Program FAQ
https://github.com/QISKit/qiskit-sdk-py/wiki/QISKit-Troubleshooting

But we should maybe change the name if QISKit-Troubleshooting to QISKit-FAQ.

update Ignis stack

remove the try it out from the header

can we remove the try it out from here.

Link documentation to locale version

The 'documentation' button links directly to the English version at https://qiskit.org/documentation/, regardless the currently selected language. E.g. a German translation of Terra doc is available, see https://qiskit.org/documentation/de/index.html
The linking to localized versions should be only optional, e.g. there is no German version of Aqua doc yet.

qiskit.org header is not responsive when browsing on mobile

Low priority, see image below:

make a page for ignis

The text is a bit to small at the top.

could we make this a bit bigger.

quickstart code fails on Windows

The example at https://www.qiskit.org/documentation/quickstart.html fails on Windows when trying to run on a local simulator. The issue appears to be related to how Windows handles multi-threading. I believe that putting the example code in a "if __name__ == 'main':" block would fix the problem for Windows users and would not hurt anyone running on other platforms. See further discussion at https://quantumexperience.ng.bluemix.net/qx/community/question?questionId=7569682980de4584ede629693e74ada8

remove the panel our vision

This is old with aer our so lets just remove

put citation format on website

@abdonrod can you please put a section under "Don't know quantum circuits" and name it "Citation". Then write a sentence:

"If you use Qiskit, please cite it as per the included BibTeX file." And that link should open the bibtex entry in plaintext.

--

Code not visible on home page of Aqua and Chemistry when using Firefox

Several users have reported (and I have confirmed it too) that on Firefox on macOS 10 the two code snippets that should be embedded in the Aqua home page (https://qiskit.org/aqua) do not show up:


Both code snippets are displayed correctly on Safari on macOS 10.

move the twitter account link to top corner

The link to qiskit twitter account should be on the top corner

Remove the tutorial link

Can we remove the tutorial link in all elements? I think that it is not clear that these all link to the tutorials.

pip install qiskit-ignis should be pip install qiskit

Create a header web component

In order to reuse in Documentation website also.

https://qiskit.org/aqua tutorials link is broken

Under qiskit.org/aqua exists a tutorials button for chemistry, due to the recent changes in the tutorials directory, the url is now moved to here: https://github.com/Qiskit/qiskit-tutorials/tree/master/qiskit/chemistry

Could we please update this url in qiskit.org?

Documentation link

Currently, when you press the documentation link in the head menu, open a new windows/tab.

We need to open in same page/tab.

Slack invite no longer active

It seems the slack invite link is no longer active, probably expired. As a short-time measure for allowing people to join slack during this weekend's Hackathon, a new one (30 days expiration date) has been generated:

https://join.slack.com/t/qiskit/shared_invite/enQtNjM0NjgwODg0MDgzLTRmODMzZDMzMTlmZjg4MWM0YjJhNjQxMzE1YjJhNDNjYzkyZTk3OTU3NmYzNDEwM2JiMzcyN2RkZTc0NzNhMDU

Update Qiskit Aqua documentation

After merge the PR "Rename acqua to aqua", now we have to leave the documentation updated.

Q Camp should be labelled Qiskit Camp

The "Q Camp" string should be replaced with "Qiskit Camp".

Update try it out URL

The URL points here: https://www.youtube.com/watch?v=V3hXSftZuoc when it should be pointing to here: https://quantum-computing.ibm.com/login

Qiskit main page directs to "qiskit" search results rather than the "qiskit" tag on Stack Exchange

Hi, I'm a site moderator at Quantum Computing Stack Exchange. Is there any specific reason why the "Stack Exchange" link on the Qiskit main page directs to the "qiskit" search results page rather than the "qiskit" tag page? Note that the tag page is much more helpful for keeping track of the latest Qiskit questions on Quantum Computing SE. I personally maintain the tag, and it's very unlikely that any Qiskit-based question will be skipped there. Also, tags are extremely useful for search purposes cf. QCSE: How do I search?.

I've asked about this on the Qiskit Slack channel earlier; Ali Javadi replied that this indeed should be updated and that I should raise it as an issue here. I hope this will be fixed. Thanks!

Update aer stack

make a page about the providers

@ajavadia can you add your ideas here.

Add to the landing page pypi qiskit

i would like on this link to https://pypi.org/project/qiskit/ like you have on the other ones since this is the main version now

Add Community Tab on header

Create a Community tab on qiskit.org to hold items from all our community related initiatives (qiskit camp, contribution guidelines, roadmap, community groups, etc.)

Documentation link router bug

When we do click on documentation link and we go back using the browser back button, the url on the navigation bar is changed but is not redirect to the previous url.

fix the broken link to link to the new index.ipynb in master

https://nbviewer.jupyter.org/github/QISKit/qiskit-tutorial/blob/stable/index.ipynb does not work with the rework. Could you link to the index in the master and then the download as a zip should work. I think we should make it more visible on the notebook so let me know if you have ideas

Host Qiskit schemas on website

A major part of the 0.6 release will be defining and implementing a set of json schema. Can we host the schemas on qiskit.org/schemas, so that the backends and anyone else who needs to validate against them has a canonical place to read them from? Each schema has, at the top of it, the address where it will be hosted:
https://github.com/Qiskit/qiskit-terra/tree/master/qiskit/schemas

Some issues:

• The schemas may change in Qiskit-Terra master. Can the website pull the latest one when they change?
• Can we host previous versions as well?

can we remove all by try it out

aqua page is not working

On Mac using firefox if i click on aqua it does not load.

blank pages on Win10

Fix broken link for tutorials

We need to update the link for the tutorials

Update year in footer

The list of supporters is too long

The list of supporters at the bottom is too long.

Suggestion:
Make it collapsable or move to a separate page.

Link to the tutorial in the header is broken

The link to the tutorial in the header is broken. 404 not found appears.

Add Github button and Install section for Aqua GUI

As Aqua's GUI has been extracted out as a separate repo/package, the GUI section of the Aqua page likely needs the following two elements:

• A Github button pointing to https://github.com/Qiskit/qiskit-aqua-interfaces

• An Install section for pip install qiskit-aqua-interfaces

Wrong capitalization of "Qiskit" in URL pointed out by "Tutorials" button in Terra Web page

The Tutorials button in https://qiskit.org/terra points to the following URL:
https://nbviewer.jupyter.org/github/QISKit/qiskit-tutorial/blob/master/index.ipynb
Please change the capitalization from QISKit to Qiskit. Thank you,