Course Project Initial Preparation

From OpenSourceSoftwarePractice

Jump to: navigation, search

Contents


Open Source Project

As initial preparation for the course project, students will get involved in one of the two following open source projects

What To Do

Students must do the following

  1. Choose one of the projects above
  2. Go to the respective web sites and download the CVS version of the source code
  3. Read the LICENSE and discuss if you agree or not with the terms
  4. Subscribe to the users mailing list of the project
    • (hint: follow the link on the left side bar of the main web page)
  5. Follow the web site instructions on how to build the software
    • post questions to the users mailing list if you find any problems building the software
  6. Submit an Experimental build to the Dashboard of the project
    • (hint: make sure that the SITE variable of your submission identifies you).
      • Run CMakeSetup (on windows) or ccmake (on Linux/Mac)
      • Go to "Advanced"
      • Search for the SITE variable and put your name on it following the format "JohnSmith"
      • Configure, Generate
      • Submit an Experimental
        • In GNU/Linux this is simply: make Experimental
        • In Windows you can open the solution in Visual Studio and build the "Experimental" projects from the IDE.
  7. Visit the Bug tracking database of the project
    • Get familiar with how to navigate the bug database
    • (hint: look at the history of the 3 most recently fixed bugs)
  8. Visit the Doxygen documentation page of the project
    • Report to the users list if you find any inconsistency in the documentation in the code
    • Get familiar with the basic Doxygen tags

Student Notes

Jon

My experience compiling VTK under a Gentoo Linux desktop machine: Follow the CVS command line instructions, while located in the directory that will house the source tree. After CVS is done, you'll have a subdirectory for VTK and for VTKData. Create a directory for the binary tree and for the installation (although I don't think that one's needed). In the binary tree, run "ccmake ../VTK", the argument is the source (CVS) tree location. Configure CMAKE_INSTALL_PREFIX and CMAKE_DATA_ROOT to the install and VTKData directory paths, respectively. Make sure the SITE (advanced) variable is set and compile, as above.

You can run the test programs in the binary tree's bin/ directory manually just to see if it works, but the path to the VTKData dir won't match up that way.

For the tests, I downloaded Dart from CVS at http://public.kitware.com/Dart/HTML/Download.shtml, and set the CMAKE var DART_ROOT to the local path, but I'm not sure whether or not that was required. The file Testing.txt in the VTK source tree gives instructions for how to run the dashboard, namely, "make Experimental" in the binary tree. This make target apparently ran all the tests and uploaded something to the server, but I don't see mine on the dashboard yet. (Update: it shows, it just took a few hours)

Compiling VTK under Vista is supposedly hell, because of a missing (deprecated) glaux.h file dependency.

- Jon

Comments by Luis Ibanez

Visual Studio should have GLAux.h in the directory: 

  C:\Program Files (x86)\Microsoft Visual Studio 8\VC\PlatformSDK\Include\gl

See the following message in the mailing list archive: 

  https://www.kitware.com/cgi-bin/mailman/private/opensourcesoftwarepractice/2007-September/000007.html

Ibanez 15:41, 19 September 2007 (EDT)

Report

Please report in the following the Dashboard (Project & Date) in which your Experimental build was submitted.


First Name Last Name SITE Project Date Link
Luis Ibanez zion.kitware ITK 2007-09-20 here
William Schroeder redwall.kitware VTK 2007-09-19 here
Jhon Adams JhonAdams VTK 2007-09-20

here

Kyle Arnone KyleMArnone VTK 2007-09-17

here

Cemal Bilgin CemalCagatayBilgin ITK 2007-09-20 here
Jonathan Brandvein JonBrandvein VTK 2007-09-19 here
Scott Dugas ScottDugas VTK 2007-09-17 here
Matt Edman MattEdman ITK 2007-09-19 here
Kyle Gancarz KyleGancarz ITK 2007-09-17 here
Joshua Hodosh JoshHodosh ITK 2007-09-20 here
Kenneth Johnson KennethJohnson VTK 2007-09-19 here
Julio Lajara JulioLajara VTK 2007-09-20 here
Eric Liebl
Patrick Marion PatrickMarion VTK, ITK 2007-09-14 here
Jean-Paul Mayer JPMayer VTK 2007-09-19 here
Kayleigh O'connor KayleighOConnor VTK 2007-09-17 here
Thomas Piekos TomPiekos VTK 2007-09-19 here
Philip Radin PhilipRadin VTK 2007-09-19 here
Matthew Stickney MattStickney ITK 2007-09-20 here
Samuel Berck SamBerck VTK 2007-09-20 here
Arunachalam Narayanaswamy Arunachalam VTK 2007-09-20 here
Amit Mukherjee AmitMukherjee ITK/VTK 2007-09-20 here
Retrieved from "http://public.kitware.com/OpenSourceSoftwarePractice/index.php/Course_Project_Initial_Preparation"