Changes between Initial Version and Version 1 of DeveloperSetup


Ignore:
Timestamp:
Oct 5, 2010, 11:55:30 AM (10 years ago)
Author:
flip
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperSetup

    v1 v1  
     1= Developer Setup =
     2
     3This explains what you need to set up Vespa if you want to make changes to
     4the code, GUI and/or database. It assumes you know a bit about Python, the
     5command line, how to use SVN, etc.
     6
     7== Prerequisites ==
     8
     9Prerequisites are described on the page [wiki:Dependencies]. You can skip
     10the prerequisites if all you want to do is look at the code (or run the
     11`depcheck` feature of `setup.py` described below). But in order to run
     12Vespa, you need to satisfy all of the prerequisites.
     13
     14In addition, you also need a Subversion client.
     15
     16When working out your dependencies, you might find
     17[SetupPy#depcheck the `depcheck` command of Vespa's `setup.py` useful].
     18
     19If you've already installed Vespa the "normal" way on your machine, you need
     20to uninstall it before creating developement setup. (If you don't, you'll have
     21two copies of the Vespa code on your machine and both you and Python will get
     22very confused as to which set of code is executing.) To uninstall, follow
     23[SetupPy#UninstallingorUnwindingaBrokenInstall the uninstall instructions].
     24Removing the data directory is optional.
     25
     26
     27== Getting the Source Code from SVN ==
     28
     29 1. Decide where your source tree is going to live. For this example, I'm
     30    going to install in `/home/me/w` (w == work).
     31 1. Check out the Vespa source code:
     32    {{{
     33    svn co https://scion.duhs.duke.edu/svn/vespa/trunk  vespa
     34    }}}   
     35 1. Find your Python's `site-packages` directory (or `dist-packages` if
     36    you're running Ubuntu with Python > 2.5) and add a plain text file
     37    called `vespa.pth` that contains the
     38    fully-qualified path to your `vespa` directory. Here's the contents of
     39    `vespa.pth` for this example --
     40    {{{
     41    /home/me/w
     42    }}}
     43    This command should tell you where `site-packages` resides:
     44    {{{
     45    python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()"
     46    }}}
     47 1. '''Optional:''' You might want some sample data with which to work. For now, that's in a
     48    separate Subversion repository from vespa. Vespa doesn't care where these files live on your
     49    local hard drive, so you
     50    can put this directory anywhere you like. In this example, I'm going to
     51    leave it under `vespa`.
     52    {{{
     53    svn co https://scion.duhs.duke.edu/svn/sample_data    sample_data
     54    }}}
     55
     56You're ready to start hacking!
     57
     58== Running Vespa Applications ==
     59
     60To run any of the apps, type
     61   {{{
     62   python /home/me/w/vespa/NAME_OF_APP/src/main.py
     63   }}}
     64where NAME_OF_APP is one of `rfpulse`, `simulation` or `analysis`.
     65
     66== User Interface Modifications (wxPython and wxGlade) ==
     67
     68If you want to modify the GUI, you'll also need to install
     69[http://wxglade.sourceforge.net/ wxGlade]. 
     70
     71=== wxGlade on Windows ===
     72If you're a Windows user, be sure to
     73[wx:wiki:InstallingWxGladeUnderWindows read this note about installing wxGlade properly].
     74
     75=== All wxGlade Users ===
     76Make sure you
     77[wx:wiki:WxGladeCustomControls read this note about configuring wxGlade]
     78to use our custom controls, regardless of what platform you are using.
     79
     80Also check our "wx" wiki page at this location:
     81https://scion.duhs.duke.edu/vespa/wx/
     82including the section entitled, "TipsBugsAndQuirks".
     83
     84== Database Modifications ==
     85
     86
     87Editing the database is described in ChangingTheDatabaseStructure.