Changes between Version 14 and Version 15 of DeveloperSetup


Ignore:
Timestamp:
May 16, 2016, 2:58:35 PM (4 years ago)
Author:
flip
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperSetup

    v14 v15  
    22
    33This explains what you need to set up Vespa if you want to make changes to
    4 the code, GUI and/or database. It assumes you know a bit about Python, the 
     4the code, GUI and/or database. It assumes you know a bit about Python, the
    55command line, how to use SVN, etc.
    66
     
    1010You can skip
    1111the prerequisites if all you want to do is look at the code (or run the
    12 `depcheck` feature of `setup.py` described below). But in order to ''run''
    13 Vespa, you need to satisfy all of the prerequisites. 
     12dependency checker described below). But in order to ''run''
     13Vespa, you need to satisfy all of the prerequisites.
    1414
    1515In addition, you also need a Subversion client.
    1616
    17 When working out your dependencies, you might find
    18 [SetupPy#depcheck the depcheck command of Vespa's setup.py useful].
     17When working out your dependencies, you might find Vespa's dependency
     18checker useful --
     19{{{
     20python -m vespa.check_dependencies
     21}}}
    1922
    2023If you've already installed Vespa the "normal" way on your machine, you need
    2124to uninstall it before creating a development setup. (If you don't, you'll have
    2225two copies of the Vespa code on your machine and both you and Python will get
    23 very confused as to which set of code is executing.) To uninstall, follow 
    24 [SetupPy#UninstallingorUnwindingaBrokenInstall the uninstall instructions]. 
     26very confused as to which set of code is executing.) To uninstall, follow
     27[SetupPy#UninstallingorUnwindingaBrokenInstall the uninstall instructions].
    2528Removing the data directory is optional.
    2629
     
    2831== Getting the Source Code from SVN ==
    2932
    30  1. Decide where your source tree is going to live. For this example, I'm 
     33 1. Decide where your source tree is going to live. For this example, I'm
    3134    going to install in `/home/me/work`
    3235 1. Check out the Vespa source code. If you have read/write access:
     
    3942    }}}
    4043
    41  1. Find your Python's `site-packages` directory (or `dist-packages` if
    42     you're running Ubuntu with Python > 2.5) and add a plain text file
     44 1. Find your Python's `site-packages` directory and add a plain text file
    4345    called `vespa.pth` that contains the
    44     fully-qualified path to your `vespa` directory. Here's the contents of
    45     `vespa.pth` for this example --
     46    fully-qualified path to your `vespa/vespa` directory (which contains
     47    `__init__.py`, the directories for `analysis`, `simulation`, etc.).
     48    Here's the contents of `vespa.pth` for this example --
    4649    {{{
    47     /home/me/work
     50    /home/me/work/vespa
    4851    }}}
    49     This command should tell you where `site-packages` resides:
     52    This command should tell you where `site-packages` resides --
    5053    {{{
    51     python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()"
     54    python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"
    5255    }}}
     56    It might be called `dist-packages` under some Linux versions.
    5357 1. '''Optional:''' If you're using Analysis, you might want some sample data with which
    5458    to work. For now, that's in a
    5559    separate Subversion repository from vespa. Vespa doesn't care where these files live on your
    56     local hard drive, so you 
    57     can put this directory anywhere you like. In this example, I'm going to 
     60    local hard drive, so you
     61    can put this directory anywhere you like. In this example, I'm going to
    5862    leave it under `vespa`.
    5963    {{{
     
    6569== Running Vespa Applications ==
    6670
    67 To run any of the apps, type 
     71To run any of the apps, type
    6872   {{{
    69    python /home/me/work/vespa/NAME_OF_APP/src/main.py
     73   python /home/me/work/vespa/vespa/NAME_OF_APP/src/main.py
    7074   }}}
    71 where NAME_OF_APP is one of `rfpulse`, `simulation` or `analysis`.
     75where NAME_OF_APP is one of `pulse`, `simulation`, `analysis`, or `priorset`.
     76Depending on which Python you're using, you might need to use `pythonw`
     77instead of `python`.
    7278
    7379== Debug Settings in vespa.ini ==
     
    7884
    7985If you want to modify the GUI, you'll also need to install
    80 [http://wxglade.sourceforge.net/ wxGlade]. 
     86[http://wxglade.sourceforge.net/ wxGlade].
    8187
    8288=== wxGlade on Windows ===
    83 If you're a Windows user, be sure to 
     89If you're a Windows user, be sure to
    8490[InstallingWxGladeUnderWindows read this note about installing wxGlade properly].
    8591