(r1.1 vs. r1.11) BuildInstructions < MouseBIRN

MouseBIRN.BuildInstructions (r1.1 vs. r1.11)

Diffs

<<O>> Difference Topic BuildInstructions (r1.11 - 08 Dec 2008 - DarenLee)

META TOPICPARENT	MouseBIRNProgrammers

Table of ContentsTOC: No TOC in "MouseBIRN.BuildInstructions"

Line: 50 to 50

If you update a tool plugin (ie: a registration method), then you need to run the build.xml for that module (ie: mbRegistration).
If you update a workspace plugin (ie: mbSearch), then you have to run the build.xml for that module (mbSearch) and the workspace plugins (mbWorkspacePlugins).

Added:

>
>

Note: The Ant build.xml files are used only to copy and package the plugin files. Although some build.xml files have "compile" targets, they are currently experimental and not always maintained.

Running MBAT 3.0

<<O>> Difference Topic BuildInstructions (r1.10 - 02 Oct 2008 - DarenLee)

META TOPICPARENT	MouseBIRNProgrammers

Table of ContentsTOC: No TOC in "MouseBIRN.BuildInstructions"

Line: 6 to 6

MBAT 3.0 Build Instructions

Changed:

<
<

If you are using Eclipse then all the configuration and build scripts should automatically compile, archive the plugins, and copy them to the appropriate locations, except for mbWorkspacePlugins, which must be run manually after all the other projects succesfully build:

mbWorkspacePlugins
- run mbWorkspacePlugins build.xml (copies plugins to mbat/dist/workspaces)

Although it should be unnecessary, if you are encountering runtime problems, refresh (F5) the mbWorkspacePlugins project (reloads the any required jar libraries in src\lib\ ) before running the build.xml script.

>
> If you are using Eclipse then all the configuration and build scripts should automatically compile, archive the plugins, and copy them to the appropriate locations. However, after initially importing or making clean, some of the build.xml may not work correctly due to project dependencies. Hence, it is recommended you follow the manual instructions below after an update or make clean.

Instructions to manually build and configure the entire source repository are given below.

<<O>> Difference Topic BuildInstructions (r1.9 - 30 Sep 2008 - DarenLee)

META TOPICPARENT	MouseBIRNProgrammers

Table of ContentsTOC: No TOC in "MouseBIRN.BuildInstructions"

Changed:

<
<

MBAT 3.0 Plugin Directory Structure

If you are using Eclipse then all the configuration and build scripts should automatically compile, zip the plugins, and copy them to the appropriate locations. If you are using another IDE, then make sure the plugins are copied to the plugins folder with the following directory structure:

>
>

MBAT 3.0 Build Instructions

mbWorkspacePlugins
- run mbWorkspacePlugins build.xml (copies plugins to mbat/dist/workspaces)

Instructions to manually build and configure the entire source repository are given below.

Eclipse Builders

By default, many of the MBAT Eclipse projects are configured to automatically run the Ant build.xml during an auto-build. To disable this feature:

Right-click on the Project -> Properties. Select "Builders" in the left panel tree view. Unselect the build.xml builder from the Builder list.

To build the projects, you must the manually run the Ant build.xml scripts as described below.

MBAT 3.0 Plugin Directory Structure

If you are using another IDE, then make sure the plugins are copied to the plugins folder with the following directory structure:

     plugins/
         mbRegistration/

Line: 14 to 33

Also, when running the executable, make sure the working directory is at the same directory level as the plugins folder. For example, in the Eclipse configuration, the plugins are located in mbat/dist/plugins and the working directory is mbat/dist.

Changed:

<
<

MBAT 3.0 Build Instructions

>
>

MBAT 3.0 build.xml scripts

In order to build and run mbat3.0, the workspaces and their plugins must be built in the following order due to dependencies. The included build.xml files automatically copy the files to the listed pre-defined locations. To run the ant build, navigate to the build.xml file in the src folder, right-click, choose "Run As"->"Ant Build...". Once you run it once it will be added to the list in the "Run As" shortcut in the toolbar.

<<O>> Difference Topic BuildInstructions (r1.8 - 30 Sep 2008 - DarenLee)

META TOPICPARENT	MouseBIRNProgrammers

Table of Contents

MBAT 3.0 Plugin Directory Structure

MBAT 3.0 Plugin Directory Structure

Changed:

<
<

If you are only developing a tool plugin, you do not have to checkout the entire mbat3.0 repository [currently, if you want to access any of the core libraries (mbManagerCart, mbManagerDocking, mbManagerIO, mbPluginManager) or modify any of the plugin APIs (mbRegistration,mbSearch,mbViewer), you need to checkout the entire repository]. In addition to the required projects for the plugin (see the wiki page for the specific plugins), you need the precompiled workspace plugins:

svn+ssh://svn.loni.ucla.edu/cvs/MouseBIRN/mbat/dist

Since the build.xml configurations assume the plugins are located in mbat/dist, you need to replicate this directory structure in your environment:

Create a mbat folder that is at the same directory level as the plugin source code (ie: mbSearchPlugins/).
Checkout the above SVN folder into mbat

The full directory structure of the dist folder is:

>
> If you are using Eclipse then all the configuration and build scripts should automatically compile, zip the plugins, and copy them to the appropriate locations. If you are using another IDE, then make sure the plugins are copied to the plugins folder with the following directory structure:

Deleted:

<
< dist/

plugins/ mbRegistration/ mbSearch/ workspaces/

Added:

>
> Also, when running the executable, make sure the working directory is at the same directory level as the plugins folder. For example, in the Eclipse configuration, the plugins are located in mbat/dist/plugins and the working directory is mbat/dist.

MBAT 3.0 Build Instructions

<<O>> Difference Topic BuildInstructions (r1.7 - 29 Sep 2008 - DarenLee)

  META TOPICPARENT  MouseBIRNProgrammers 

Table of ContentsTOC: No TOC in "MouseBIRN.BuildInstructions"
->
>
+  MBAT 3.0 Plugin Directory Structure 
If you are only developing a tool plugin, you do not have to checkout the entire mbat3.0 repository [currently, if you want to access any of the core libraries (mbManagerCart, mbManagerDocking, mbManagerIO, mbPluginManager) or modify any of the plugin APIs (mbRegistration,mbSearch,mbViewer), you need to checkout the entire repository]. In addition to the required projects for the plugin (see the wiki page for the specific plugins), you need the precompiled workspace plugins:


 svn+ssh://svn.loni.ucla.edu/cvs/MouseBIRN/mbat/dist



Since the build.xml configurations assume the plugins are located in mbat/dist, you need to replicate this directory structure in your environment:


 Create a mbat folder that is at the same directory level as the plugin source code (ie: mbSearchPlugins/).

 Checkout the above SVN folder into mbat



The full directory structure of the dist folder is:
   dist/
      plugins/
          mbRegistration/
          mbSearch/
          workspaces/
   MBAT 3.0 Build Instructions
-<
<
+In order to build and run mbat3.0, the workspaces and their plugins must be built in the following order due to dependencies. Most of the included build.xml files automatically copy the files to the listed pre-defined locations. To run the ant build, navigate to the build.xml file in the src folder, right-click, choose "Run As"->"Ant Build...". Once you run it once it will be added to the list in the "Run As" shortcut in the toolbar.
->
>
+In order to build and run mbat3.0, the workspaces and their plugins must be built in the following order due to dependencies. The included build.xml files automatically copy the files to the listed pre-defined locations. To run the ant build, navigate to the build.xml file in the src folder, right-click, choose "Run As"->"Ant Build...". Once you run it once it will be added to the list in the "Run As" shortcut in the toolbar.
  mbRegistration

 run mbRegistration build.xml (copies mbRegistration.jar to mbWorkspacePlugins\plugins\net.nbirn.mbat.plugins.workspace.Registration\src\lib)
-<
<
+ run mbRegistrationPlugins build.xml (copies plugins to mbRegistration/plugins)
->
>
+ run mbRegistrationPlugins build.xml (copies plugins to mbat/dist/plugins/mbRegistration)
  mbSearch

 run mbSearch build.xml (copies mbSearch.jar to mbWorkspacePlugins\plugins\net.nbirn.mbat.plugins.workspace.Search\src\lib)
-<
<
+ run mbSearchPlugins build.xml (copies plugins to mbSearch/plugins)
->
>
+ run mbSearchPlugins build.xml (copies plugins to mbat/dist/plugins/mbSearch)
  mbViewer

 run mbViewer build.xml (copies mbViewer.jar to mbWorkspacePlugins\plugins\net.nbirn.mbat.plugins.workspace.Viewer\src\lib)



 mbWorkspacePlugins

 For Eclipse, refresh (F5) mbWorkspacePlugins project (reloads the any required jar libraries in src\lib\ )
-<
<
+ run mbWorkspacePlugins build.xml (copies plugins to mbat/workspaces)
->
>
+ run mbWorkspacePlugins build.xml (copies plugins to mbat/dist/workspaces)
 <!--   1 mbManagerCart



 run mbManagaerCart build.xml (copies mbManagerCart.jar to common\lib) -->
  package: net.nbirn.mbat.applicationNEW

 class: mbMain.java
-<
<
+To run, navigate to mbMain.java, right-click, choose "Run As"->"Java Application".
->
>
+To run:

 Navigate to mbMain.java, right-click, choose "Run As"->"Java Application"

 If the application fails to find the plugin folder, configure the run working directory
   Running workspace clients for testing
-<
<
+Under construction...
->
>
+Each workspace contains standalone clients for testing and debugging. The Main.java class is found under the net.nbirn.mbat.*.client package for that workspace (ie: net.nbirn.mbat.registration.client.Main).

To run:

 Navigate to the Main.java class for the workspace, right-click, choose "Run As"->"Java Application"

 If the application fails to find the plugin folder, configure the run working directory

<<O>> Difference Topic BuildInstructions (r1.6 - 23 Sep 2008 - DarenLee)

META TOPICPARENT	MouseBIRNProgrammers

Table of ContentsTOC: No TOC in "MouseBIRN.BuildInstructions"

Line: 16 to 16

1. run mbSearchPlugins build.xml (copies plugins to mbSearch/plugins)
mbViewer
1. run mbViewer build.xml (copies mbViewer.jar to mbWorkspacePlugins\plugins\net.nbirn.mbat.plugins.workspace.Viewer\src\lib)

Deleted:

<
<

mbManagerCart
1. run mbManagaerCart build.xml (copies mbManagerCart.jar to common\lib)

mbWorkspacePlugins
1. For Eclipse, refresh (F5) mbWorkspacePlugins project (reloads the any required jar libraries in src\lib\ )
2. run mbWorkspacePlugins build.xml (copies plugins to mbat/workspaces)

Added:

>
>

<!-- 1 mbManagerCart

1. run mbManagaerCart build.xml (copies mbManagerCart.jar to common\lib) -->

General build dependency rules:

If you update a tool plugin (ie: a registration method), then you need to run the build.xml for that module (ie: mbRegistration).

<<O>> Difference Topic BuildInstructions (r1.5 - 12 Sep 2008 - DarenLee)

META TOPICPARENT	MouseBIRNProgrammers

Table of ContentsTOC: No TOC in "MouseBIRN.BuildInstructions"

Line: 6 to 6

MBAT 3.0 Build Instructions

Changed:

<
< In order to build and run mbat3.0, the workspaces and their plugins must be built in the following order due to dependencies. Most of the included build.xml files automatically copy the files to the listed pre-defined locations.

>
> In order to build and run mbat3.0, the workspaces and their plugins must be built in the following order due to dependencies. Most of the included build.xml files automatically copy the files to the listed pre-defined locations. To run the ant build, navigate to the build.xml file in the src folder, right-click, choose "Run As"->"Ant Build...". Once you run it once it will be added to the list in the "Run As" shortcut in the toolbar.

mbRegistration
1. run mbRegistration build.xml (copies mbRegistration.jar to mbWorkspacePlugins\plugins\net.nbirn.mbat.plugins.workspace.Registration\src\lib)

Line: 14 to 14

mbSearch
1. run mbSearch build.xml (copies mbSearch.jar to mbWorkspacePlugins\plugins\net.nbirn.mbat.plugins.workspace.Search\src\lib)
2. run mbSearchPlugins build.xml (copies plugins to mbSearch/plugins)

Added:

>
>

mbViewer
1. run mbViewer build.xml (copies mbViewer.jar to mbWorkspacePlugins\plugins\net.nbirn.mbat.plugins.workspace.Viewer\src\lib)
mbManagerCart
1. run mbManagaerCart build.xml (copies mbManagerCart.jar to common\lib)

mbWorkspacePlugins
1. For Eclipse, refresh (F5) mbWorkspacePlugins project (reloads the any required jar libraries in src\lib\ )
2. run mbWorkspacePlugins build.xml (copies plugins to mbat/workspaces)

Line: 24 to 29

Changed:

<
<

MBAT 3.0 Test Client

To maintain backwards compatibility with mbat2.0, a separate mbat3.0 test client is added to:

>
>

Running MBAT 3.0

The main() function is located in:

project: mbat
source folder: src/mbat_src
package: net.nbirn.mbat.applicationNEW

Changed:

<
<

class: mbMain

>
>

class: mbMain.java

To run, navigate to mbMain.java, right-click, choose "Run As"->"Java Application".

Running workspace clients for testing

Under construction...

<<O>> Difference Topic BuildInstructions (r1.4 - 19 Aug 2008 - DarenLee)

META TOPICPARENT	MouseBIRNProgrammers

Table of ContentsTOC: No TOC in "MouseBIRN.BuildInstructions"

Line: 29 to 29

To maintain backwards compatibility with mbat2.0, a separate mbat3.0 test client is added to:

project: mbat
source folder: src/mbat_src

Changed:

<
<

package: net.nbirn.mbat.application.NEW

>
>

package: net.nbirn.mbat.applicationNEW

class: mbMain

Added:

>
>

Debugging JPF plugins

Instructions to setup Eclipse for debugging can be found here: http://jpf.sourceforge.net/ide-eclipse.html

<<O>> Difference Topic BuildInstructions (r1.3 - 07 Aug 2008 - DarenLee)

META TOPICPARENT	MouseBIRNProgrammers

Table of ContentsTOC: No TOC in "MouseBIRN.BuildInstructions"

Line: 12 to 12

1. run mbRegistration build.xml (copies mbRegistration.jar to mbWorkspacePlugins\plugins\net.nbirn.mbat.plugins.workspace.Registration\src\lib)
2. run mbRegistrationPlugins build.xml (copies plugins to mbRegistration/plugins)
mbSearch

Changed:

<
<

1. run mbSearch build.xml [7/22/2008 currently does nothing]

>
>

1. run mbSearch build.xml (copies mbSearch.jar to mbWorkspacePlugins\plugins\net.nbirn.mbat.plugins.workspace.Search\src\lib)

1. run mbSearchPlugins build.xml (copies plugins to mbSearch/plugins)
mbWorkspacePlugins

Changed:

<
<

1. For Eclipse, refresh (F5) mbWorkspacePlugins project

>
>

1. For Eclipse, refresh (F5) mbWorkspacePlugins project (reloads the any required jar libraries in src\lib\ )

1. run mbWorkspacePlugins build.xml (copies plugins to mbat/workspaces)

General build dependency rules:

<<O>> Difference Topic BuildInstructions (r1.2 - 22 Jul 2008 - DarenLee)

  META TOPICPARENT  MouseBIRNProgrammers
-<
<
+  MBAT 3.0 Build Instructions
->
>
+Table of Contents

 MBAT 3.0 Build Instructions






  MBAT 3.0 Build Instructions
 In order to build and run mbat3.0, the workspaces and their plugins must be built in the following order due to dependencies. Most of the included build.xml files automatically copy the files to the listed pre-defined locations.


 mbRegistration

 run mbRegistration build.xml (copies mbRegistration.jar to mbWorkspacePlugins\plugins\net.nbirn.mbat.plugins.workspace.Registration\src\lib)
-<
<
+ run mbRegistrationPlugins build.xml (copies plugins to mbRegistration/plugins
->
>
+ run mbRegistrationPlugins build.xml (copies plugins to mbRegistration/plugins)
  mbSearch
-<
<
+ run mbSearch build.xml
->
>
+ run mbSearch build.xml [7/22/2008 currently does nothing]
  run mbSearchPlugins build.xml (copies plugins to mbSearch/plugins)



 mbWorkspacePlugins
->
>
+ For Eclipse, refresh (F5) mbWorkspacePlugins project
  run mbWorkspacePlugins build.xml (copies plugins to mbat/workspaces)
->
>
+General build dependency rules:

 If you update a tool plugin (ie: a registration method), then you need to run the build.xml for that module (ie: mbRegistration). 

 If you update a workspace plugin (ie: mbSearch), then you have to run the build.xml for that module (mbSearch) and the workspace plugins (mbWorkspacePlugins).





  MBAT 3.0 Test Client 

To maintain backwards compatibility with mbat2.0, a separate mbat3.0 test client is added to:

 project: mbat

 source folder: src/mbat_src

 package: net.nbirn.mbat.application.NEW

 class: mbMain

<<O>> Difference Topic BuildInstructions (r1.1 - 22 Jul 2008 - DarenLee)

Line: 1 to 1

Added:

>
>

META TOPICPARENT	MouseBIRNProgrammers

MBAT 3.0 Build Instructions

In order to build and run mbat3.0, the workspaces and their plugins must be built in the following order due to dependencies. Most of the included build.xml files automatically copy the files to the listed pre-defined locations.

mbRegistration
1. run mbRegistration build.xml (copies mbRegistration.jar to mbWorkspacePlugins\plugins\net.nbirn.mbat.plugins.workspace.Registration\src\lib)
2. run mbRegistrationPlugins build.xml (copies plugins to mbRegistration/plugins
mbSearch
1. run mbSearch build.xml
2. run mbSearchPlugins build.xml (copies plugins to mbSearch/plugins)
mbWorkspacePlugins
1. run mbWorkspacePlugins build.xml (copies plugins to mbat/workspaces)

Topic: BuildInstructions . { View | Diffs | r1.11 | > | r1.10 | > | r1.9 | More }

Revision r1.1 - 22 Jul 2008 - 22:03 - DarenLee
Revision r1.11 - 08 Dec 2008 - 20:35 - DarenLee