Giter Club home page Giter Club logo

qiskit-textbook's Introduction

stable: Build Status master: Build Status

Qiskit Textbook Source Code

This is the repository for the open-source Learn Quantum Computation using Qiskit textbook. The textbook is intended for use as a university quantum algorithms course supplement as well as a guide for self-learners who are interested in learning quantum programming.

The Jupyter notebooks corresponding to each section of the textbook can be found in the content folder. The code in these notebooks will constantly be updated to the latest version of Qiskit.

The notebooks are compiled into html and exported to the website.

Contributors Guide

General Guidelines

We love contributions and need them to ensure the textbook is a high-quality resource. If you notice any mistakes and want to fix them, then feel free to go ahead and make a pull request. If you want to contribute original content, there are a few things you can do to make sure your efforts have the biggest impact:

  • Please open an issue explaining your proposed additions. Here we can discuss where your contribution will fit in, as well as making sure it fits the style and format of the rest of the textbook.
  • Create a pull request while your chapter is in progress, this way we can review it in the process of writing instead of asking for large changes after you have already written it.
  • Try to follow the formatting and tone of the existing notebooks to ensure everything renders correctly and the textbook is coherent.

How to Edit the Textbook

The textbook uses jupyter book to generate the site from jupyter notebooks. To edit the pages you will first need to install jupyter and Qiskit, you can use the links below to help you do this:

If you are unfamiliar with git, you can follow this guide to making contributions:

You will need to fork the textbook, make changes in your own branch, then submit a pull request which we will review before merging. You must use jupyter notebook to edit the pages. If you change any code, please re-run the notebook (you can do this using the โญ button at the top of the notebook editor) to update the cell outputs.

Important: The notebooks to edit are inside the content folder.

For a list of contributors, see the .bib file.

License

The materials and associated source code of this open-source textbook are licensed under Apache License 2.0.

Contact

For any issues, please contact Abraham Asfaw ([email protected]).

qiskit-textbook's People

Contributors

frankharkins avatar delapuente avatar quantumjim avatar 1ucian0 avatar amyami187 avatar schwarmco avatar aasfaw avatar esobimpe avatar mrthankyou avatar jahanclaes avatar joschaef avatar htransistor avatar abbycross avatar jwoehr avatar spencerking avatar attp avatar dlyongemallo avatar jiahaoyao avatar justcadams avatar lerongil avatar qu-tan-um avatar brycefuller avatar anedumla avatar ozlemsalehi avatar nathanearnestnoble avatar starktech23 avatar jeremiahbuckley avatar ebaeumer avatar warrenalphonso avatar usman4d avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.