-
David Verelst authoredDavid Verelst authored
Developer guide
Thank you for your interest in developing wetb. This guide details how to contribute to wetb in a way that is efficient for everyone.
Contents
- Fork
- Requirements
- Install Python
- Install/build dependencies
- Get wetb
- Install wetb
- Contributions
- Upload contributions
- Make and upload wheels
Fork project
We prefer that you make your contributions in your own fork of the project, make your changes and make a merge request.
The project can be forked to your own user account via the <Fork> button on the frontpage
Requirements
Command line
This guide will use the command line (aka command prompt) frequently. You can launch a Windows terminal as follows: press Start> and type "cmd" + <Enter>. A link to the command prompt should be visible now.
In case you want an alternative, more capable windows terminal, you could consider using ConEmu (this is optional).
ConEmu-Maximus5 is a Windows console emulator with tabs, which presents multiple consoles and simple GUI applications as one customizable GUI window with various features.
Git
-
Download and install Git version control system for Windows 64-bit here. Only select the Windows Portable option if you know what you are doing or if you do not have administrative rights on your computer.
-
Git comes with a simple GUI, but there are more and different options available if you are not happy with it, see here.
-
On windows we highly recommend tortoisegit. It is a gui integrated into the windows explorer.
Install Python
For all platforms we recommend that you download and install the Anaconda - a professional grade, full blown scientific Python distribution.
Installing Anaconda, activate root environment
- Download and install Anaconda (Python 3.5 version, 64 bit installer is recommended) from https://www.continuum.io/downloads
Note: The Python 2.7 or Python 3.5 choice of Anaconda only affects the root environment. You can always create additional environments using other Python versions, see below.
- Update the root Anaconda environment (type in a terminal):