CHIRP

h1. Setting up a Win32 Development Environment

{{toc}}

h2. Overview

Chirp is written in Python, an interpreted language. To run the chirp code directly you need Python installed as well as several other external libraries:

 * PyGTK - GTK cross-platform GUI,

 * PySerial - serial port connectivity for Python

 * PyLibXML2 - XML processing

You must also obtain a copy of the chirp source code, either by downloading the .tar.gz archive or by using the Mercurial source code management system, known as hg. Installing Mercurial will allow you to pull the latest updates from the chirp site and automates submission of patches for inclusion in future chirp builds. If you intend on submitting patches and working with the chirp development community is it strongly recommended that you install Mercurial and use it for submitting patches and keeping your sources current.

For MS windows, chirp is distributed as a compiled .exe file that installs the compiled code and the necessary runtime dependencies. The compiled .exe files eliminate the need for the Python interpreter. Additional downloads and steps are needed to create chirp installer (.exe) files if you need to distribute your work to other systems for testing.

To summarize the steps are:

 # install python

 # install additional python libraries PyGTK, PySerial, PyLibXML2

 # install Mercurial (hg) SCM

 # Use Mercurial to download the current chirp source code and keep it up to date.

h2. Installing Python

To run chirp you will need to install Python 2.7.x from either "Python.org":http://python.org or "ActiveState":http://www.activestate.com/activepython.  Do not install Python 3 as chirp is currently written for Python 2.7 and above, but will generally run on Python 2.6.x.

 * "Python 2.7.x":http://python.org/download/releases/2.7.6/

 * "ActivePython Community Edition":http://www.activestate.com/activepython/downloads

See the steps below to add Python to your system's path after installation.

h2. Library and Runtime Prerequisites

In addition to Python, several other libraries are needed for the GTK cross-platform GUI, serial port connectivity, and XML processing.

Get and install the following in this order:

 # "PyGTK Win32 All-in-one installer":http://ftp.gnome.org/pub/GNOME/binaries/win32/pygtk/2.24/

 # "PyLibXML2":http://users.skynet.be/sbi/libxml-python/

 # "PyWin32":http://sourceforge.net/projects/pywin32/files/pywin32/

 # "PySerial":http://sourceforge.net/projects/pyserial/files/pyserial/2.5/

Notes:

 * For any of the above, be sure to get the latest version, and the py27 variant if/when available.

 * If you are on 64-bit Windows, you must download the versions with the same bitness (either 64-bit or 32-bit) in order for everything to work together, all 32-bit or all 64-bit. 

 ** If your intent is to be able to build an .exe for others to test/use, you should use only the 32-bit versions to ensure the generated .exe will install and run on the widest range of Windows systems.

 * On Windows 7 (and possibly other newer versions of Windows with UAC) the PyLibXML2 installer will generate an error during the installation about not being able to modify the runtime directory. (This appears to be bening but needs to be confirmed.)

When everything is installed, you will want to make sure that Python is in your system PATH variable:

h2. Putting Python in your path.

After installing python, you will need to add it to your path.  The Active State Python installer for ActivePython handles this for you.  If you installed from python.org follow these instructions.

h3. Windows XP

 * On the Desktop or in the Start menu, right-click on *My Computer* and choose *Properties*

 * In the dialog that opens, on the *Advanced* tab, click on *Environment Variables*

 * Under *System variables*, find *Path*, select it, and then edit *Edit*

 * At the end of the existing value, add exactly this string: @;C:\Python27@ (obviously adjust this path if you installed it elsewhere. Don't forget the leading semicolon)

 * Click the *OK* buttons until you're done.

h3. Windows Vista/7

 * In the Windows menu, right-click on the *Computer* item and choose *Properties*

 * Click on *Advanced System Settings* on the left

 * In the dialog that opens, click on *Environment Variables*

 * Under *System variables*, find *Path*, select it, and then edit *Edit*

 * At the end of the existing value, add exactly this string: @;C:\Python27\bin@ (obviously adjust this path if you installed it elsewhere. Don't forget the leading semicolon)

 * Click the *OK* buttons until you're done.

h1. CHIRP source code and development process.

The chirp developers use the "Mercurial source code management system":http://mercurial.selenic.com/, also known as hg for managing the chirp source code and supporting distributed development. Installing Mercurial will allow you to pull the latest updates from the chirp site and automates submission of patches for inclusion in future chirp builds. While you can download a .tar.gz copy of the chirp sources this is not recommend as your sources will become quickly out of date.

h2. Install Mercurial

Get and install the mercurial source code management tool:

 * "Mercurial SCM":http://mercurial.selenic.com/

h2. Clone the repository

The next step is to download a copy of the repository. This is done from the command-line, and will create a @chirp.hg/@ directory in your current directory. Thus, you should change to the place you want it to be first. For example:

<pre>

C:\Users\Foo> cd \MyWorkspace

C:\MyWorkspace> hg clone http://d-rats.com/hg/chirp.hg

</pre>

h2. Learn about the Chirp development process and how to use Mercurial

See [[DevelopersProcess|Chirp Development Processs|]].

h1. Run chirp

Python should be in your search path from the install, but if not, put it in the system PATH environment variable. Once you do that, you should be able to enter the directory that was created in the clone step above, and run chirpw with python:

<pre>

C:\MyWorkspace> cd chirp.hg

C:\MyWorkspace\chirp.hg> python chirpw

</pre>

h1. Setting up a Win32 Build Environment to create chirp .exe files

The following notes are for setting up a chirp build environment on a Win32 system, that can be used to create chirp .exe files and the installer for running on other Win32 systems without requiring a Python environment. Note: it is probably best to use the 32 bit versions of all of the components if your intent is to build an .exe that will work on the widest range of Windows systems.

# Follow the directions above to create a working chirp development environment

# Install py2exe - This utility creates .exe files from python environments.  See http://www.py2exe.org/

## make

## unix2dos

# Install cygwin - Cygwin provides a Unix/Linux like environment on a Windows system using the freely available GNU tools. See http://www.cygwin.com/

## During the cygwin installation, make sure zip and unzip are installed (from the Archive group) to provide the command line tools that can be used to manipulate ZIP files.

# install NSIS - The free Nullsoft Scriptable Install System is used to create Windows installer packages.  These are the .exe's that most users will download to install chirp on a Windows system.  See http://nsis.sourceforge.net/

h2. Creating Win32 .exe files

Follow the above instructions to setup a chirp build environment on a Windows system.

# Launch Cygwin Terminal to get a command prompt.

# cd to the chirp.hg directory where your sources are.

# run ./build/make_Win32_build.sh 

# The output in winds up in c:\cygwin (To Be Verified)