Difference between revisions of "Jwoodlee Week 12"

Revision as of 04:59, 24 November 2015

Individual Journal Assignment

The "Milestones" can be found here on the Coder guild page.

Milestone 1: Version Control Setup

Since I already had a GitHub account, Dondi added me to the XMLPipeDB project on GitHub. I then selected the branch dropdown menu on the project entitled "Branch:master" and typed into the create new branch field "s-flexneri". This will allow me to make my own commits without changing the master branch.

Milestone 2: “Developer Rig” Setup and Initial As-Is Build

I downloaded Eclipse IDE for Java EE Developers and ran the .exe. From there, I followed the instruction on:GenMAPP Builder Project Setup and Initial Build.

1. Follow the instructions in the section of this wiki page in order to:
   • Set up a functioning Eclipse development environment for your branch of GenMAPP Builder.
   • Build your own copy of GenMAPP Builder from scratch.
2. (with QA) Get a full import-export cycle done.
3. (with QA) Decide on a file/version management scheme/system.

I installed Eclipse to the T drive on my lab computer because I decided that would be my development environment. I also determined I wanted my Git clone to be on my T drive as well. So I used cd to get into the T drive and typed the command: git clone https://github.com/lmu-bioinformatics/xmlpipedb.git. I used cd To get into the clone folder: xmlpipedb. I switched to the "s-flexneri" branch: git checkout s-flexneri so my commits will be in the proper branch.

Eclipse Workspace Setup

1. Run Eclipse.
2. When Eclipse asks you to select a workspace, click the Browse… and navigate to your repository clone folder. Select it and click on Open.
3. Verify that your repository clone folder is what is listed as the Workspace:. Click on OK.
4. You will see an introductory display with assorted menu items. Click the Workbench button (upper-right corner, with a 3D arrow for an icon).
5. If everything went well, you should now see an empty developer area, showing your repository clone folder in the window title with a Project Explorer tab on the left (see screenshot for an example).

Java Project Setup

1. Right-click anywhere within the empty Project Explorer tab and choose New > Project… from the menu that appears.
2. Choose Java Project from the list of “wizards” and click on the Next > button.
3. On the next panel, enter gmbuilder as the Project name:. Note how the Location: field underneath, although disabled, should show your cloned repository folder location with /gmbuilder appended to it.
4. Verify that the JRE section is showing Java 8 or 1.8. If not, talk to Dr. Dionisio.
5. Click on the Finish button (yes, there is no need for further configuration).
6. If Eclipse asks you whether you want to open the “Java perspective,” respond with Yes. You may check the Remember my decision checkbox if you wish.
7. You should now see a gmbuilder project folder in the Project Explorer tab.
8. If the gmbuilder project folder icon shows a red x icon, do the following:
   • Right-click on the gmbuilder item and choose Properties from the menu that appears.
   • Click on the Java Compiler item. Click on the item name itself, not its triangle.
   • You should see that Compiler compliance level: is set to 1.6. If so, uncheck the Enable project specific settings checkbox.
   • Click the Apply button. If Eclipse asks you whether it is OK to rebuild the project, click Yes.
   • Click on OK to dismiss the Properties dialog.
   • See if the red x icon has disappeared.
9. If the red x icon persists, please show your setup to fellow guild members or Dr. Dionisio for troubleshooting.

Initial Build

1. Open the gmbuilder project by clicking on the gray triangle to the left of its name.
2. Within the gmbuilder Java project is a file called build.xml. It should have an icon that appears to include an ant.
3. Right-click on build.xml and choose Run As > Ant Build... (the one with the ellipses) from the menu that appears.
4. In the Edit Configuration dialog that appears, uncheck dist if it is already checked.
5. Check on the clean and dist items in the Targets tab. The Target execution order section near the bottom of the dialog should say clean, dist.
6. Click the Run button. The computer will work for a bit. You will see some messages scroll up on the Console tab if that tab is visible.
7. When it is done, right-click on the gmbuilder project folder and choose Refresh from the menu that appears (F5 is its keyboard shortcut).
8. You should see a dist folder appear inside the gmbuilder project folder.
9. This is your personally-built copy of GenMAPP Builder. Its contents correspond to the extracted contents of the gmbuilder-3.0.0-build-5.zip file that was downloaded in class.

Milestone 3: Species Profile Creation

Follow the instructions in the Adding a Species Profile to GenMAPP Builder section of this wiki page in order to:

• Add a species profile to the GenMAPP Builder code base.
• Customize the species profile with the species name in the OrderedLocusNames record of the Systems table.
• Customize the Link field in the OrderedLocusNames record of the Systems table to hold a URL query with ~ standing in for the gene ID.
  • (with QA) The URL would need to be determined first, of course.

Milestone 4: Species Export Customization

1. Based on observations from the GenMAPP User and QA, determine and document (as thoroughly as possible) any other modified export behavior that GenMAPP Builder will have to manifest for this species.
2. Implement this export behavior.
3. As needed, commit and push your work to your GitHub branch.
4. Additional milestones will depend on how the rest of the project goes, and the bugs/features generated by that work.
5. Document/log all work done, problems encountered, and how they were resolved.
6. When your work is complete, issue a GitHub pull request to merge your branch into the main development line.

BIOL 367, Fall 2015, User Page, Team Page