Changes between Version 26 and Version 27 of DevDocs


Ignore:
Timestamp:
08/19/08 14:26:17 (10 years ago)
Author:
kmilner
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • DevDocs

    v26 v27  
    1313== Creating Modules for the SEATREE GUI ==
    1414
    15 A modules is simply a python class which extends the [source:python/seatree/modules/module.py Module] class (located in seatree/modules/module.py).
     15A modules is simply a python class which extends the [source:trunk/python/seatree/modules/module.py Module] class (located in python/seatree/modules/module.py).
    1616
    17 To create your own module, first look at the [source:python/seatree/modules/example/exampleModule.py simple example module] (located in python/seatree/modules/example/exampleModule.py). You can also look at the code of the existing modules.
     17To create your own module, first look at the [source:trunk/python/seatree/modules/example/exampleModule.py simple example module] (located in python/seatree/modules/example/exampleModule.py). You can also look at the code of the existing modules.
    1818
    19 Each module should also contain a plotter, which extends the [source:python/seatree/plotter/plotter.py Plotter] class. The currently available plotters are:
     19Each module should also contain a plotter, which extends the [source:trunk/python/seatree/plotter/plotter.py Plotter] class. The currently available plotters are:
    2020
    21  * [source:python/seatree/plotter/imagePlotter.py ImagePlotter] A plotter for simply displaying images in the SEATREE GUI.
    22  * [source:python/seatree/plotter/gmt/gmtPlotter.py GMTPlotter] A plotter that extends [source:python/seatree/plotter/imagePlotter.py ImagePlotter] and displays GMT plots
    23  * [source:python/seatree/plotter/matPlotLib/matPlotLibPlotter.py MatPlotLibPlotter] A plotter that for displaying [http://matplotlib.sourceforge.net/ MatPlotLib] plots (IN DEVOLOPMENT)
     21 * [source:trunk/python/seatree/plotter/imagePlotter.py ImagePlotter] A plotter for simply displaying images in the SEATREE GUI.
     22 * [source:trunk/python/seatree/plotter/gmt/gmtPlotter.py GMTPlotter] A plotter that extends [source:trunk/python/seatree/plotter/imagePlotter.py ImagePlotter] and displays GMT plots
     23 * [source:trunk/python/seatree/plotter/matPlotLib/matPlotLibPlotter.py MatPlotLibPlotter] A plotter that for displaying [http://matplotlib.sourceforge.net/ MatPlotLib] plots (IN DEVOLOPMENT)
    2424
    2525== Installing Your Modules ==
    … …  
    2727=== Using the SEATREE Installer (preferred) ===
    2828
    29 To install your module you need to create a configuration file inside the python/conf/install directory. For the [source:python/seatree/modules/example/exampleModule.py ExampleModule], the configuration file should look like this:
     29To install your module you need to create a configuration file inside the python/conf/install directory. For the [source:trunk/python/seatree/modules/example/exampleModule.py ExampleModule], the configuration file should look like this:
    3030
    3131{{{
    … …  
    4545The <importName> tag is the filename of the your module's main class, so for exampleModule.py it is simply exampleModule. If the module is within the SEATREE package structure, you could enter something like: seatree.modules.example.exampleModule .
    4646
    47 The <className> tag is the name of the class that extends [source:python/seatree/modules/module.py Module], [source:python/seatree/modules/example/exampleModule.py ExampleModule] in this case.
     47The <className> tag is the name of the class that extends [source:trunk/python/seatree/modules/module.py Module], [source:trunk/python/seatree/modules/example/exampleModule.py ExampleModule] in this case.
    4848
    4949The <directory> tag is the name of the directory within seatree.modules where your module resides.
    … …  
    5151The <installImportName> and <installClassName> tags are the same as <importName> and <className> except that they correspond to the installer. If no installer is necessary, just omit these values.
    5252
    53 An [source:python/seatree/modules/example/exampleInstaller.py example installer] can be found in python/seatree/modules/example/exampleInstaller.py.
     53An [source:trunk/python/seatree/modules/example/exampleInstaller.py example installer] can be found in python/seatree/modules/example/exampleInstaller.py.
    5454
    5555=== Manual Installation ===
    … …  
    5959If you want the change to only affect your user or don't have write privileges to the SEATREE directory, you can copy the conf.xml file to the .seatree folder created in your home directory (ex: 'cp python/conf/conf.xml ~/.seatree/'). SEATREE will load 1 configuration file, first looking in your home directory, and then defaulting to the main conf.xml file in python/conf if ~/.seatree/conf.xml doesn't exist.
    6060
    61 The SEATREE configuration file for an installation with only [source:python/seatree/modules/example/exampleModule.py ExampleModule] installed would look like this:
     61The SEATREE configuration file for an installation with only [source:trunk/python/seatree/modules/example/exampleModule.py ExampleModule] installed would look like this:
    6262
    6363{{{
    … …  
    7777The <importName> tag is the filename of the your module's main class, so for exampleModule.py it is simply exampleModule. If the module is within the SEATREE package structure, you could enter something like: seatree.modules.example.exampleModule.
    7878
    79 The <className> tag is the name of the class that extends [source:python/seatree/modules/module.py Module], [source:python/seatree/modules/example/exampleModule.py ExampleModule] in this case.
     79The <className> tag is the name of the class that extends [source:trunk/python/seatree/modules/module.py Module], [source:trunk/python/seatree/modules/example/exampleModule.py ExampleModule] in this case.
    8080
    8181The <directory> tag is the path to the directory containing your module.