<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Development guide — PyWavelets Documentation</title> <link rel="stylesheet" href="../_static/nature.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/language_data.js"></script> <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within PyWavelets Documentation" href="../_static/opensearch.xml"/> <link rel="shortcut icon" href="../_static/favicon.ico"/> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Preparing Windows build environment" href="preparing_windows_build_environment.html" /> <link rel="prev" title="Contributing" href="../contributing.html" /> <meta name="description" content="PyWavelets is a scientific Python module for Wavelet Transform calculations."/> <meta name="keywords" content="PyWavelets, wavelets, Python, wavelet transform, discrete wavelet transform, dwt, idwt, swt, wavelet packets, stationary wavelet transform, pywt"/> <meta name="author" content="Filip Wasilewski"/> <meta name="Distribution" content="Global"/> <meta name="Robots" content="INDEX,FOLLOW"/> <script type="text/javascript"> (function ($) { $(document).ready(function () { $("#toggle-edit-info").click(function (e) { e.preventDefault(); $("#edit-info").toggle(); }); }); })(jQuery); </script> <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-3396395-3']); _gaq.push(['_trackPageview']); (function () { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="preparing_windows_build_environment.html" title="Preparing Windows build environment" accesskey="N">next</a> |</li> <li class="right" > <a href="../contributing.html" title="Contributing" accesskey="P">previous</a> |</li> <li><a href="../index.html">Home »</a></li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="development-guide"> <span id="dev-index"></span><h1>Development guide<a class="headerlink" href="#development-guide" title="Permalink to this headline">¶</a></h1> <p>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.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="preparing_windows_build_environment.html">Preparing Windows build environment</a><ul> <li class="toctree-l2"><a class="reference internal" href="preparing_windows_build_environment.html#installing-windows-sdk-c-c-compiler">Installing Windows SDK C/C++ compiler</a></li> <li class="toctree-l2"><a class="reference internal" href="preparing_windows_build_environment.html#mingw-c-c-compiler">MinGW C/C++ compiler</a></li> <li class="toctree-l2"><a class="reference internal" href="preparing_windows_build_environment.html#next-steps">Next steps</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="preparing_linux_build_environment.html">Preparing Linux build environment</a><ul> <li class="toctree-l2"><a class="reference internal" href="preparing_linux_build_environment.html#installing-basic-build-tools">Installing basic build tools</a></li> <li class="toctree-l2"><a class="reference internal" href="preparing_linux_build_environment.html#next-steps">Next steps</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="installing_build_dependencies.html">Installing build dependencies</a><ul> <li class="toctree-l2"><a class="reference internal" href="installing_build_dependencies.html#setting-up-python-virtual-environment">Setting up Python virtual environment</a></li> <li class="toctree-l2"><a class="reference internal" href="installing_build_dependencies.html#installing-cython">Installing Cython</a></li> <li class="toctree-l2"><a class="reference internal" href="installing_build_dependencies.html#installing-numpy">Installing numpy</a></li> <li class="toctree-l2"><a class="reference internal" href="installing_build_dependencies.html#installing-sphinx">Installing Sphinx</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="building_extension.html">Building and installing PyWavelets</a><ul> <li class="toctree-l2"><a class="reference internal" href="building_extension.html#installing-from-source-code">Installing from source code</a></li> <li class="toctree-l2"><a class="reference internal" href="building_extension.html#installing-a-development-version">Installing a development version</a></li> <li class="toctree-l2"><a class="reference internal" href="building_extension.html#installing-a-regular-release-from-pypi">Installing a regular release from PyPi</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a><ul> <li class="toctree-l2"><a class="reference internal" href="testing.html#continous-integration-with-travis-ci">Continous integration with Travis-CI</a></li> <li class="toctree-l2"><a class="reference internal" href="testing.html#running-tests-locally">Running tests locally</a></li> <li class="toctree-l2"><a class="reference internal" href="testing.html#running-tests-with-tox">Running tests with Tox</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="how_to_release.html">Guidelines for Releasing PyWavelets</a><ul> <li class="toctree-l2"><a class="reference internal" href="how_to_release.html#updating-the-release-notes">Updating the release notes</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_release.html#tag-the-release">Tag the release</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_release.html#build-windows-os-x-and-linux-wheels-and-upload-to-pypi">Build Windows, OS X and Linux wheels and upload to PyPI</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_release.html#create-the-source-distribution">Create the source distribution</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_release.html#upload-the-release-to-pypi">Upload the release to PyPI</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_release.html#update-conda-forge">Update conda-forge</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_release.html#create-the-release-on-github">Create the release on GitHub</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_release.html#announcing-the-release">Announcing the release</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_release.html#prepare-for-continued-development">Prepare for continued development</a></li> </ul> </li> </ul> </div> <div class="section" id="something-not-working"> <h2>Something not working?<a class="headerlink" href="#something-not-working" title="Permalink to this headline">¶</a></h2> <p>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 <a class="reference external" href="http://groups.google.com/group/pywavelets">http://groups.google.com/group/pywavelets</a> or open a ticket on <a class="reference external" href="https://github.com/PyWavelets/pywt">GitHub</a>.</p> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="../index.html">Table of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Development guide</a><ul> <li><a class="reference internal" href="#something-not-working">Something not working?</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="../contributing.html" title="previous chapter">Contributing</a></p> <h4>Next topic</h4> <p class="topless"><a href="preparing_windows_build_environment.html" title="next chapter">Preparing Windows build environment</a></p><div> <h3>Quick links</h3> <ul> <li><a href="https://github.com/PyWavelets/pywt"><img src="../_static/github.png" height="16" width="16" alt="" /> Fork on Github</a></li> <li><a href="http://groups.google.com/group/pywavelets"><img src="../_static/comments.png" height="16" width="16" alt="" /> Discussion Group</a></li> <li><a href="http://wavelets.pybytes.com/"><img src="../_static/wave.png" height="16" width="16" alt="" /> Explore Wavelets</a></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <script type="text/javascript">$('#searchbox').show(0);</script> <div id="edit-instructions"> <h3>Edit this document</h3> <p> <a href="#" id="toggle-edit-info"> <img src="../_static/page_edit.png" height="16" width="16" alt="" /> 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. </a> </p> <ol id="edit-info" style="display: none;"> <li> Go to <i><a href="https://github.com/PyWavelets/pywt/blob/master/doc/source/dev/index.rst" target="_blank"> Development guide </a></i> on GitHub. </li> <li> Press <b>Edit this file</b> button. </li> <li> Edit file contents using GitHub's text editor in your web browser </li> <li> Fill in the <b>Commit message</b> text box at the end of the page telling <i>why</i> you did the changes. Press <b>Propose file change</b> button next to it when done. </li> <li> On <i>Send a pull request</i> page you don't need to fill in text anymore. Just press <b>Send pull request</b> button. </li> <li> Your changes are now queued for review under project's <a href="https://github.com/PyWavelets/pywt/pulls" target="_blank">Pull requests</a> tab on Github. </li> </ol> </div> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="preparing_windows_build_environment.html" title="Preparing Windows build environment" >next</a> |</li> <li class="right" > <a href="../contributing.html" title="Contributing" >previous</a> |</li> <li><a href="../index.html">Home »</a></li> </ul> </div> <div class="footer" role="contentinfo"> © Copyright 2006-2019, The PyWavelets Developers. Last updated on Jan 12, 2019. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3. </div> </body> </html>