/platypus

Qiskit Textbook (beta)

Primary LanguageJupyter NotebookApache License 2.0Apache-2.0

Important

This repository and its content have been superseded by IBM Quantum Learning. These source files are no longer maintained and may contain errors. Contributions to this repo are no longer accepted.

platypus

This repository is home of the new Qiskit Textbook.

The previous version of the Qiskit Textbook textbook can be found here.

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.

Tools & technologies

  • Python - interpreted, interactive, object-oriented programming language
  • Jupyter Notebooks - documents containing interactive code and rich text
  • Node.js - JavaScript runtime
  • Mathigon Studio - platform for highly interactive online courses
  • Typescript - JavaScript with syntax for types
  • Vue 3 - framework for building user interfaces
  • Sass/SCSS - stylesheet language
  • Cypress - front end testing tool

Getting Started

Pre-requisites

  1. Python 3.10 environment with textbook_converter requirements installed

    $ cd platypus/converter/textbook-converter
$ pip install -r requirements.txt -r requirements-test.txt

  2. Node.js (Using any version from 14.0 to 16.19.0) (you could install node.js from here)

Setup

$ cd platypus
$ git submodule update --init --recursive
$ npm install
$ npm run build
$ npm start

To watch changes and rebuild automatically run with npm run watch after installing the dependencies.

After the application has started, the site will be available at http://localhost:8080/, but the index route will redirect to an external landing page.

In order to test the application locally, you can visit a specific course page, like http://localhost:8080/course/ch-prerequisites/.

You can specify the port setting the env variable PORT. For instance PORT=5000 npm start.

Content contributions

If you want to help improve the textbook's content, check out the contributors guide, and the code of conduct. If you would like to help us make the textbook accessible in different languages please see the localization guide.

License

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