Development guide

This section contains information on building and installing PyWavelets from source code as well as instructions for preparing the build environment on Windows and Linux.

• PyWavelets Code of Conduct
  • Introduction
  • Specific Guidelines
  • Diversity Statement
  • Reporting Guidelines
  • Incident reporting resolution & Code of Conduct enforcement
  • Endnotes
• Preparing Windows build environment
• Preparing Linux build environment
  • Installing basic build tools
  • Next steps
• Installing build dependencies
  • Setting up Python virtual environment
  • Installing Cython
  • Installing numpy
  • Installing Sphinx
• Building and installing PyWavelets
  • Installing from source code
  • Installing a development version
  • Installing a regular release from PyPi
• Testing
  • Continuous integration with GitHub Actions
  • Running tests locally
  • Running tests with Tox
• How to build the docs locally
• Guidelines for Releasing PyWavelets
  • Updating the release notes
  • Tag the release
  • Build Windows, OS X and Linux wheels and upload to PyPI
  • Create the source distribution
  • Upload the release to PyPI
  • Update conda-forge
  • Create the release on GitHub
  • Announcing the release
  • Prepare for continued development

Something not working?

If these instructions are not clear or you need help setting up your development environment, go ahead and ask on the PyWavelets discussion group at http://groups.google.com/group/pywavelets or open a ticket on GitHub.