Navigation

  • index
  • next |
  • previous |
  • Home »
  • Development guide

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 Travis-CI
    • Running tests locally
    • Running tests with Tox
  • 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.

Table of Contents

  • Development guide
    • Something not working?

Previous topic

Contributing

Next topic

PyWavelets Code of Conduct

Quick links

  • Fork on Github
  • Discussion Group
  • Explore Wavelets

Quick search

Edit this document

The source code of this file is hosted on GitHub. Everyone can update and fix errors in this document with few clicks - no downloads needed.

  1. Go to Development guide on GitHub.
  2. Press Edit this file button.
  3. Edit file contents using GitHub's text editor in your web browser
  4. Fill in the Commit message text box at the end of the page telling why you did the changes. Press Propose file change button next to it when done.
  5. On Send a pull request page you don't need to fill in text anymore. Just press Send pull request button.
  6. Your changes are now queued for review under project's Pull requests tab on Github.

Navigation

  • index
  • next |
  • previous |
  • Home »
  • Development guide
© Copyright 2006-2023, The PyWavelets Developers. Last updated on Apr 20, 2023. Created using Sphinx 5.3.0.