Difference between revisions of "Jwoodlee Week 12"

From LMU BioDB 2015
Jump to: navigation, search
(→‎Individual Journal Assignment: began procedure)
(→‎Milestone 1: Version Control Setup: added some procedural stuff)
Line 2: Line 2:
  
 
=== 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.  From there I  
+
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.
 +
 
 +
 
  
  
  
−
#* 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
 
# ''(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 ===

Revision as of 01:38, 24 November 2015

Individual Journal Assignment

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.



  1. (with QA) Commit and push relevant source data to the GenMAPP Gene Databases folder of your GitHub branch

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

  1. Install core software for developing, building, and testing prototype versions of GenMAPP Builder:
    • Java developer tools: 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 7-zip on the Seaver 120 machines)
    • XMLPipeDB Match utility
    • Development environment: while any will do, Eclipse is the specific one that most XMLPipeDB developers have used:
      • Download and install Eclipse from its 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.
  2. Follow the instructions in the 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.
  3. (with QA) Get a full import-export cycle done.
  4. (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.

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

Weekly Assignments Individual Journal Pages Shared Journal Pages
Retrieved from "https://xmlpipedb.lmucs.io/biodb/fall2015/index.php?title=Jwoodlee_Week_12&oldid=6812"