Skip to content
This repository was archived by the owner on Aug 21, 2023. It is now read-only.

Commit

Permalink
Index file fix and link fixes (#304)
Browse files Browse the repository at this point in the history
* Fixes #231

* Grammar fixes to index

Also fix some links that had QISKit vs Qiskit

* Index file fix

* Merge remote-tracking branch 'Qiskit/master' into index_file_fix

# Conflicts:
#	INSTALL.md
#	README.md

* fixing some links and typos
  • Loading branch information
jaygambetta authored Oct 8, 2018
1 parent 258c5c1 commit 2d3bb8f
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 34 deletions.
4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@

**Get the tutorials**<BR>

For the full experience, you can start by [downloading](https://github.com/QISKit/qiskit-tutorial/archive/master.zip) the tutorials. Unzip the archive in the directory of your choice. Alternatively, the more advanced user may choose to use `git`. If you have `git` installed, run
For the full experience, you can start by [downloading](https://github.com/Qiskit/qiskit-tutorial/archive/master.zip) the tutorials. Unzip the archive in the directory of your choice (this is the recommend way). Alternatively, the more advanced user may choose to use `git`. If you have `git` installed, run

```
git clone https://github.com/QISKit/qiskit-tutorial.git
git clone https://github.com/Qiskit/qiskit-tutorial.git
```

To properly view and run the tutorials, you will need to install [Jupyter Notebook](https://jupyter.readthedocs.io/en/latest/install.html).
Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ In this repository, we've put together a collection of Jupyter notebooks aimed a

The notebooks for these tutorials can be viewed here on GitHub. But for the full experience, you'll want to interact with them!

The easiest way to do this is using [the Binder image](https://mybinder.org/v2/gh/QISKit/qiskit-tutorial/master?filepath=index.ipynb), which lets you use the notebooks via the web. This means that you don't need to download or install anything, but is also means that you should not insert any private information into the notebooks (such as your API key). We recommend as pointed out in issue #231 that after you are done using mybinder that you regenerate your token.
The easiest way to do this is using [the Binder image](https://mybinder.org/v2/gh/Qiskit/qiskit-tutorial/master?filepath=index.ipynb), which lets you use the notebooks via the web. This means that you don't need to download or install anything, but it also means that you should not insert any private information into the notebooks (such as your API key). We recommend as pointed out in [issue #231](https://github.com/Qiskit/qiskit-tutorial/issues/231) that after you are done using mybinder that you regenerate your token.

Please refer to this [installation guide](INSTALL.md) for installing and setting up Qiskit and the tutorials on your own machine.
Please refer to this [installation guide](INSTALL.md) for setting up Qiskit and the tutorials on your own machine (this is the recommended way).

***

Expand All @@ -37,10 +37,11 @@ We've collected a core reference set of notebooks in this section outlining the
### 2. [Community notebooks](community/)<a id='community'></a>
Teaching quantum computing and qiskit has many different paths of learning. We love our community, and we love the contributions so keep them coming. Because Qiskit is changing so much, at the moment we cant keep this updated, but there are some great notebooks in here. See:
- [Hello, Quantum World](community/hello_world/) learn from the community how to write your first quantum program.
- [Quantum games](community/hello_world/), learn quantum computing by having fun.
- [Quantum algorithms](community/algorithms/), learn Qiskit from the textbook algorithms.
- [Teach Me Qiskit 2018](community/teach_me_qiskit_2018/), learn from the great contributions to the Teach Me Qiskit.
- [Terra Advanced](community/terra/), learn more advanced features of Qiskit Terra from the community.
- [Quantum Games](community/games/), learn quantum computing by having fun.
- [Textbook Quantum Algorithms](community/algorithms/), learn Qiskit from the textbook algorithms.
- [Quantum Information Science with Terra](community/terra/), learn about quantum information science with Qiskit Terra code.
- [Quantum Algorithms](community/aqua/), learn about quantum algorithms for noisy near-term devices with Qiskit Aqua code.
- [Teach Me Qiskit 2018](community/teach_me_qiskit_2018/), learn from the great contributions to the [Teach Me Qiskit award](https://www.ibm.com/blogs/research/2018/06/teach-qiskit-winner/).

To go though the tutorial load up the [index.ipynb](index.ipynb) notebook and start learning.

Expand All @@ -49,7 +50,7 @@ To go though the tutorial load up the [index.ipynb](index.ipynb) notebook and st
## Contributing
If you would like to contribute to the tutorials, there are a number of ways to get involved:

* **Issues**: Issues can be reported with GitHub [issue reporting](https://github.com/QISKit/qiskit-tutorial/issues) for this repository. Select `New issue`, fill in a descriptive title, and provide as much detail as is needed for the issue to be reproduced.
* **Issues**: Issues can be reported with GitHub [issue reporting](https://github.com/Qiskit/qiskit-tutorial/issues) for this repository. Select `New issue`, fill in a descriptive title, and provide as much detail as is needed for the issue to be reproduced.
* **Notebooks**: If you would like to contribute a notebook, please create a [fork](https://help.github.com/articles/fork-a-repo/) of the repository from the `master` branch and create a [pull request](https://help.github.com/articles/about-pull-requests/) for your change. Note that new notebooks should be placed in the relevant part of the [Community](community/) section.

## Contributors
Expand Down
46 changes: 21 additions & 25 deletions index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
"\n",
"Welcome Qiskitters to the Quantum Information Science Kit ([Qiskit](https://www.qiskit.org/) for short)! \n",
"\n",
"To get you started, we have put together a set of tutorials that can be downloaded by clicking [here!](https://github.com/Qiskit/qiskit-tutorial/archive/master.zip).\n",
"The easiest way to get started is to use [the Binder image](https://mybinder.org/v2/gh/Qiskit/qiskit-tutorial/master?filepath=index.ipynb), which lets you use the notebooks via the web. This means that you don't need to download or install anything, but is also means that you should not insert any private information into the notebooks (such as your API key). We recommend that after you are done using mybinder that you regenerate your token. \n",
"\n",
"For setup and installation instructions can be view [here](https://github.com/Qiskit/qiskit-tutorial/blob/master/INSTALL.md).\n",
"To tutorials can be downloaded by clicking [here](https://github.com/Qiskit/qiskit-tutorial/archive/master.zip) and to set them up follow the installation instructions [here](https://github.com/Qiskit/qiskit-tutorial/blob/master/INSTALL.md).\n",
"\n",
"***\n",
"\n",
Expand All @@ -36,23 +36,26 @@
"#### 1.1 Getting started with Qiskit\n",
"\n",
"A central goal of Qiskit is to build a software stack that makes it easy for anyone to use quantum computers. To get developers and researchers going we have a set of tutorials on the basics. \n",
" * [Getting started](qiskit/basics/getting_started.ipynb) - how to use Qiskit.\n",
" * [The IBMQ provider](qiskit/basics/the_ibmq_provider.ipynb) - Working with the IBMQ provider.\n",
" * [Qiskit visualizations](qiskit/basics/qiskit_visualizations.ipynb) - illustrates the different visualizations of Qiskit.\n",
" * 3rd Party Provider\n",
" * [Getting started](qiskit/basics/getting_started.ipynb) - how to use Qiskit\n",
" * [The IBMQ provider](qiskit/basics/the_ibmq_provider.ipynb) - Working with the IBMQ provider\n",
" * [Qiskit visualizations](qiskit/basics/qiskit_visualizations.ipynb) - illustrates the different visualizations of Qiskit\n",
" * 3rd Party Provider - illustrate how to add external backends to Qiskit\n",
" \n",
"#### 1.2 Qiskit Terra\n",
"\n",
"Terra, the ‘earth’ element, is the foundation on which the rest of the software lies. Terra provides a bedrock for composing quantum programs at the level of circuits and pulses, to optimize them for the constraints of a particular device, and to manage the execution of batches of experiments on remote-access devices. Terra defines the interfaces for a desirable end-user experience, as well as the efficient handling of layers of optimization, pulse scheduling and backend communication.\n",
" * [Using different gates](qiskit/terra/using_different_gates.ipynb) - list of gates in Terra and their linear algebra.\n",
" * The quantum circuit\n",
" * [Using different gates](qiskit/terra/using_different_gates.ipynb) - list of gates in Terra and their linear algebra\n",
" * Using the QuantumCircuit object\n",
" * Compiling and executing a quantum program\n",
" * The Transpiler \n",
" \n",
"#### 1.3 Qiskit Aer\n",
"\n",
"Aer, the ‘air’ element, permeates all Qiskit elements. To really speed up development of quantum computers we need better simulators, emulators and debuggers. Aer will help us understand the limits of classical processors by demonstrating to what extent they can mimic quantum computation. Furthermore, we can use Aer to verify that current and near-future quantum computers function correctly. This can be done by stretching the limits of simulation to accommodate 50+ qubits with reasonably high depth, and by simulating the effects of realistic noise on the computation.\n",
" * Simulating the statevector\n",
" * Simulating the unitary\n",
" * Simulating with noise\n",
" * Using the Clifford simulator\n",
" \n",
"#### 1.4 Qiskit Ignis\n",
"Ignis, the ‘fire’ element, is dedicated to fighting noise and errors and to forging a new path. This includes better characterization of errors, improving gates, and computing in the presence of noise. Ignis is meant for those who want to design quantum error correction codes, or who wish to study ways to characterize errors through methods such as tomography, or even to find a better way for using gates by exploring dynamical decoupling and optimal control. While we have already released parts of this element as part of libraries in Terra, an official stand-alone release will come soon. For now we have some tutorials for you to explore.\n",
Expand All @@ -67,41 +70,34 @@
" * [Optimization](qiskit/aqua/classical_optimization.ipynb) - using variational quantum eigensolver to experiment with optimization problems on a quantum computer \n",
" * [Artificial Intelligence](qiskit/aqua/svm_q_kernel.ipynb) - using quantum-enhanced support vector machine to experiment with classification problems on a quantum computer\n",
"\n",
"### 3. Community Notebooks\n",
"### 2. Community Notebooks\n",
"\n",
"Teaching quantum and qiskit has so many different paths of learning. We love our community and we love the contributions so keep them coming. Because Qiskit is changing so much we cant keep this updated (we will do our best!) but there are some great notebooks in here.\n",
"Teaching quantum and qiskit has so many different paths of learning. We love our community and we love the contributions so keep them coming. Because Qiskit is changing so much we cant keep this updated (we will try our best) but there are some great notebooks in here.\n",
"\n",
"#### 3.1 [Hello, Quantum World with Qiskit](community/hello_world/) \n",
"#### 2.1 [Hello, Quantum World with Qiskit](community/hello_world/) \n",
"Learn from the community how to write your first quantum program.\n",
"\n",
"#### 3.2 [Quantum Games with Qiskit](community/games/)\n",
"#### 2.2 [Quantum Games with Qiskit](community/games/)\n",
"Learn quantum computing by having fun. How is there a better way!\n",
"\n",
"#### 3.3 [Textbook Quantum Algorithms with Qiskit](community/algorithms/)\n",
"#### 2.3 [Textbook Quantum Algorithms with Qiskit](community/algorithms/)\n",
"Learn Qiskit from the textbook quantum algorithms, like Shor, Grover, and Deutsch-Jozsa. \n",
"\n",
"#### 3.4 [Quantum Information Science with Qiskit Terra](community/terra/)\n",
"#### 2.4 [Quantum Information Science with Qiskit Terra](community/terra/)\n",
"Learn about and how to program quantum circuits using Qiskit Terra. \n",
"\n",
"#### 3.5 [Developing Quantum Applications with Qiskit Aqua](community/aqua/)\n",
"#### 2.5 [Developing Quantum Applications with Qiskit Aqua](community/aqua/)\n",
"Learn how to develop and the fundamentals of quantum applications using Qiskit Aqua\n",
"\n",
"#### 3.6 [Teach Me Qiskit 2018](community/teach_me_qiskit_2018/index.ipynb)\n",
"Learn from the great contributions to the [Teach Me Qiskit](https://qe-awards.mybluemix.net/) Award.\n",
"#### 2.6 [Teach Me Qiskit 2018](community/teach_me_qiskit_2018/index.ipynb)\n",
"Learn from the great contributions to the [Teach Me Qiskit Award](https://qe-awards.mybluemix.net/).\n",
"\n",
"\n",
"*** \n",
"\n",
"## License\n",
"This project is licensed under the Apache License 2.0 - see the [LICENSE](https://github.com/Qiskit/qiskit-tutorial/blob/master/LICENSE) file for details."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
Expand All @@ -120,7 +116,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.6.4"
"version": "3.6.3"
}
},
"nbformat": 4,
Expand Down

0 comments on commit 2d3bb8f

Please sign in to comment.