Difference between revisions of "Jwoodlee Week 12"

From LMU BioDB 2015
Jump to: navigation, search
(Individual Journal Assignment: added procedure)
(Initial Build: added procedure)
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Individual Journal Assignment ==
 
== Individual Journal Assignment ==
 
+
The "Milestones" can be found [https://xmlpipedb.cs.lmu.edu/biodb/fall2015/index.php/Coder here] on the Coder guild page.
 
=== Milestone 1: Version Control Setup ===
 
=== Milestone 1: Version Control Setup ===
 
+
Since I already had a GitHub account, Dondi added me to the [https://github.com/lmu-bioinformatics/xmlpipedb 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.
# Get a GitHub account and pass it to Dr. Dionisio so that you can be added as a developer of the [https://github.com/lmu-bioinformatics/xmlpipedb XMLPipeDB project on GitHub].
+
#* Once you are set up as a developer, you can clone and push your GenMAPP Builder source code.
+
# Create a GitHub branch of ''xmlpipedb'' for your team.
+
#* The easiest way to do this is via the ''Branch'' dropdown menu on the [https://github.com/lmu-bioinformatics/xmlpipedb GitHub project website for XMLPipeDB].
+
# ''(with QA)'' Commit and push relevant source data to the ''GenMAPP Gene Databases'' folder of your GitHub branch
+
#* You can always verify what is publicly visible on your branch by visiting the [https://github.com/lmu-bioinformatics/xmlpipedb XMLPipeDB GitHub website], choosing your branch from the ''Branch'' dropdown menu, then inspecting the code that is visible there.
+
  
 
=== Milestone 2: “Developer Rig” Setup and Initial As-Is Build ===
 
=== Milestone 2: “Developer Rig” Setup and Initial As-Is Build ===
  
# Install core software for developing, building, and testing prototype versions of GenMAPP Builder:
+
I downloaded [http://www.eclipse.org Eclipse IDE for Java EE Developers] and ran the .exe. From there, I followed the instruction on:[https://xmlpipedb.cs.lmu.edu/biodb/fall2015/index.php/Coder#GenMAPP_Builder_Project_Setup_and_Initial_Build GenMAPP Builder Project Setup and Initial Build].
#* Java developer tools: [http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html JDK 8] (which, at this writing, is ''JDK 8u65'')
+
#* A ''git'' client (for interacting with GitHub)
+
#* Any tool that can unpack .gz and .zip files (we are using [http://www.7-zip.org/ 7-zip] on the Seaver 120 machines)
+
#* ''XMLPipeDB Match'' utility
+
#* Development environment: while any will do, [http://www.eclipse.org Eclipse] is the specific one that most XMLPipeDB developers have used:
+
#** Download and install Eclipse from its [http://www.eclipse.org/downloads download web site]. Either '''Eclipse IDE for Java Developers''' or '''Eclipse IDE for Java EE Developers''' will work.
+
#** Eclipse includes ''ant'' so you do not need a separate ''ant'' installation unless you plan to build GenMAPP Builder outside of Eclipse
+
#** If you want to use ''ant'' outside Eclipse, please visit http://ant.apache.org.
+
# Follow the instructions in the [[#GenMAPP Builder Project Setup and Initial Build|GenMAPP Builder Project Setup and Initial Build]] 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.
+
# ''(with QA)'' Get a full import-export cycle done.
+
# ''(with QA)'' Decide on a file/version management scheme/system.
+
  
As needed, coders may arrange for a walkthrough or other help session with Dr. Dionisio if there are any issues with the procedures on this guild page.
+
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 <code>cd</code> to get into the T drive and typed the command: <code> git clone https://github.com/lmu-bioinformatics/xmlpipedb.git</code>.  I used <code> cd </code> To get into the clone folder: <code>xmlpipedb</code>.  I switched to the "s-flexneri" branch: <code> git checkout s-flexneri </code> so my commits will be in the proper branch.
  
=== Milestone 3: Species Profile Creation ===
+
When I first started up eclipse I selected the repository clone folder as my work space.  I then clicked the workbench button.  This setup my eclipse work space.
  
Follow the instructions in the [[#Adding a Species Profile to GenMAPP Builder|Adding a Species Profile to GenMAPP Builder]] section of this wiki page in order to:
+
[[Image:Initial-eclipse-workspace.png|thumb]]
* 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 <code>~</code> standing in for the gene ID.
+
** ''(with QA)'' The URL would need to be determined first, of course.
+
  
=== Milestone 4: Species Export Customization ===
+
==== Java Project Setup ====
 +
*I right clicked in the Project Explorer tab and chose New > Project...
 +
*I then chose Java Project from the list of wizards and clicked Next.
 +
* On the next panel, I entered <code>gmbuilder</code> as the ''Project name:''.
 +
* I clicked on the ''Finish'' button with no further configuration.
 +
* I clicked Yes when Eclipse asked if I wanted to open the Java perspective.
  
# 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.
+
==== Initial Build of GenMAPP Builder in Eclipse====
# Implement this export behavior.
+
I opened the gmbuilder project by clicking on the little gray triangle left of its name.  I right clicked on build.xml and chose Run As > Ant Build... (including ellipses).
# As needed, commit and push your work to your GitHub branch.
+
I then unchecked dist and rechecked clean and dist in the Targets tab in that order. When the order of the Target execution order box saidclean, dist I clicked the Run button. Eclipse finished building the build and then I right clicked on the gmbuilder project folder and hit refresh. This created a new dist and thus I created a personally built copy of GenMAPP Builder.
# Additional milestones will depend on how the rest of the project goes, and the bugs/features generated by that work.
+
# Document/log all work done, problems encountered, and how they were resolved.
+
# When your work is complete, issue a GitHub ''pull request'' to merge your branch into the main development line.
+
  
 
{{Template: Jwoodlee}}
 
{{Template: Jwoodlee}}

Latest revision as of 05:38, 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.

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.

When I first started up eclipse I selected the repository clone folder as my work space. I then clicked the workbench button. This setup my eclipse work space.

Initial-eclipse-workspace.png

Java Project Setup

  • I right clicked in the Project Explorer tab and chose New > Project...
  • I then chose Java Project from the list of wizards and clicked Next.
  • On the next panel, I entered gmbuilder as the Project name:.
  • I clicked on the Finish button with no further configuration.
  • I clicked Yes when Eclipse asked if I wanted to open the Java perspective.

Initial Build of GenMAPP Builder in Eclipse

I opened the gmbuilder project by clicking on the little gray triangle left of its name. I right clicked on build.xml and chose Run As > Ant Build... (including ellipses). I then unchecked dist and rechecked clean and dist in the Targets tab in that order. When the order of the Target execution order box saidclean, dist I clicked the Run button. Eclipse finished building the build and then I right clicked on the gmbuilder project folder and hit refresh. This created a new dist and thus I created a personally built copy of GenMAPP Builder.


BIOL 367, Fall 2015, User Page, Team Page

Weekly Assignments Individual Journal Pages Shared Journal Pages