SciPy contributor guide#

This guide is designed to help you quickly find the information you need about SciPy development after you’ve reviewed the introductory material in Ways to Contribute or Contributor quickstart guide.

You can also watch SciPy Development Workflow, a five-minute video example of fixing a bug and submitting a pull request.

  • Development environment - how to set up and maintain a development environment, including installing compilers and SciPy dependencies, creating a personal fork of the SciPy repository on GitHub, using git to manage a local repository with development branches, performing an in-place build of SciPy, and creating a virtual environment that adds this development version of SciPy to the Python path

  • Editing SciPy - how to edit SciPy Python code, with tips on finding which module contains SciPy functionality to be edited, adding new modules to SciPy, and complying with PEP8 style standards

  • Unit tests - how to write and run unit tests for SciPy with the pytest framework

  • Documentation - how to write reStructuredText documentation that complies with docstring standards, build documentation locally with Sphinx, and view documentation built during continuous integration checks

  • Benchmarks - how to benchmark code with airspeed velocity

  • Compiled code - how to add fast, compiled code to SciPy

  • Continuous Integration - how does our continuous integration system works and how to debug your PR

Development environment#

Editing SciPy#

Unit tests#

  • Testing Guidelines is the definitive guide to writing unit tests of NumPy or SciPy code (part of the NumPy documentation)

  • Running SciPy Tests Locally documents runtests.py, a convenient script for building SciPy and running tests locally

Documentation#

Benchmarks#

Compiled code#