Development guide

The Development guide contains information regarding how to contribute to the PennyLane codebase.

The guides below are aimed towards developers and cover how to install PennyLane and its dependencies in development mode, run and add tests, write documentation, as well as general best practices and an architectural overview of PennyLane, plugins, and devices.

Installation

Installation and dependencies of the PennyLane source code using development mode.

Contribution guide

How to get involved in the PennyLane community and help improve PennyLane.

Software tests

Installing dependencies, running the PennyLane test suite and measuring coverage.

Documentation

Building and contributing modules and packages to the PennyLane documentation.

Submitting a pull request

Creating and submitting a pull request to the PennyLane repository.

Architecture Design Records

Proposing important PennyLane architectural decisions.

Logging guidelines

Defining how to develop using logging supports in PennyLane.

Architectural overview

Architectural overview of PennyLane, its plugins and devices.

Deprecations and Removals

Ensuring safety when introducing breaking changes to PennyLane.

development/guide

 

Download Python script

 

Download Notebook

 

View on GitHub