platypus

This repository is home of the new Qiskit Textbook (beta).

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

Python (3.6 or later) environment with textbook_converter requirements installed

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

Node.js (14.0 or later)

Setup

$ cd platypus
$ 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 https://localhost:8080/course/ch-prerequisites/.

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

Contribution

If you'd like to contribute to Qiskit Textbook (beta), please take a look at our contributors guide and code of conduct

When opening a PR against the main branch, a preview build might be generated and deployed. The same redirection logic as the one described in the Setup section will apply, meaning that one would need to visit a specific course page to access the preview build.

License

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