Developing Tools for nanohub.org. Michael McLennan Software Architect Network for Computational Nanotechnology

Transcription

1 Developing Tools for nanohub.org Michael McLennan Software Architect Network for Computational Nanotechnology

2 Why bother uploading tools? Most people just post their source code: Users have to: Download Unpack Compile / Install oops! Something went wrong here Hello, I am grad student from Kazakhstan. Your tool not compile for me. I get errors. That s a not very nice. Hey, can you help me?

3 Access tools online

4 Deliver ANY Graphical Application via the Web Content Database Maxwell s Daemon Physical Machine Virtual Machine nanowire job nanohub cluster Violin Rendering Farm

5 Case in point: Schred Rappture version Feb Users Last 12 months Not many that want to download/compile

6 Upload process is semi-automatic

7 Intellectual property considerations

8 Putting out Open Source /* * ================================================= * AUTHOR: Michael McLennan, Purdue University * Copyright (c) 2007 Purdue Research Foundation * * See the file "license.terms" for information on * usage and redistribution of this file, and for a * DISCLAIMER OF ALL WARRANTIES. * ================================================= */ license.terms your code

9 Start a contribution

10 Start a contribution

11 Know where you stand

12 Overview of the process waiting for Contribution form User nanohub team Registered Created Uploaded Installed Updated Approved Published Retired

13 Registering your tool waiting for Contribution form User nanohub team Registered Created Uploaded Start the process by filling out a form that tells us about your tool: Tool name/version Who can run the tool? Who can access the code? Installed Published Updated Approved Retired

14 Creating a project area Contribution form User waiting for nanohub team Registered Created Uploaded Installed Published Updated Approved We create a project area for your tool on our developer site Wiki for project documentaton Subversion source code control Ticketing system for bugs Retired

15 Your project area Buttons to access project functions: Wiki documentation Source code Ticketing system NOTE: You may have to log in to see some buttons

16 Editing wiki pages Wiki Markup Once logged in, you can edit

17 Wiki mark-up Complete instructions in your project area at wiki/wikiformatting

18 Creating wiki pages Your project name /wiki section Make up a name

19 Linking wiki pages Create the page first, then link to it: Any word with mixed case is treated as a link Or, create the link first, then click on the link to create the page:

20 Back to the process Contribution form User waiting for nanohub team Registered Created Uploaded Installed Published Updated Approved We create a project area for your tool on our developer site Wiki for project documentaton Subversion source code control Ticketing system for bugs Retired

21 What s happening? or go to

22 Tool Status

23 Uploading your code waiting for Contribution form User nanohub team Registered Created Uploaded Upload your code into a nanohub workspace. Compile, test, and commit changes back to your Subversion repository. Installed Published Updated Approved Retired

24 Using nanohub workspaces Once your tool has been registered and created, you should be approved for workspace access. You ll see workspaces listed on your my nanohub page: See workspace tutorial on nanohub svn checkout app-yourtool cd app-yourtool/rappture vi tool.xml rappture See instructions in your project area at wiki/gettingstarted

25 Using nanohub workspaces Once your tool has been registered and created, you should be approved for workspace access. You ll see workspaces listed on your my nanohub page: rappture vi tool.xml rappture svn add tool.xml cd.. svn commit See Subversion tutorial on nanohub

26 What is Rappture? Rappture = Simulation Code Scientist Rapid Application Infrastructure Created by NCN in Nov 2004 Open Source Rappture tutorial on nanohub Works with your favorite programming language

27 Rappture works by defining the interface XML interface description <?xml version="1.0"?> <run> <tool> <title>name of the tool</title> <about>description and </command> <limits> <cputime>900</cputime> <filesize> </filesize> </limits> </tool> <input>... </input> <output>... </output> </run> integer: n integer: m choice: sim method CNTbands model curve: E-k diagram curve: DOS molecule: structure

28 Over 60 tools online at nanohub.org 50 more tools in the development pipeline

29 Uploading your code waiting for Tool status page: Contribution form User nanohub team Registered Created Uploaded Installed Updated Approved Published Retired

30 Uploading your code waiting for Tool status page: Contribution form User nanohub team Registered Created Uploaded Installed Updated Approved Published Retired

31 Edit your tool information page This is the page that people see when they find your tool on nanohub.org

32 Installing your tool waiting for Contribution form User nanohub team Registered Created Installed Uploaded Updated Approved We install your tool Latest code from Subversion Compile, install Set up testing permissions Published Retired

33 waiting for Testing your tool Contribution form User nanohub team Registered Created Uploaded Installed Updated Approved Published Retired

34 waiting for Testing your tool Contribution form User nanohub team Registered Created Uploaded Installed Updated Approved Published Retired

35 Updating your tool waiting for Contribution form User nanohub team Registered Created Uploaded Installed Updated Approved We re-install your tool Latest code from Subversion Compile, install Published Retired

36 Testing your tool again waiting for Contribution form User nanohub team Registered Created Uploaded Installed Updated Approved Published Retired

37 Last step waiting for Contribution form User nanohub team Registered Created Uploaded Installed Updated Published Approved Retired We publish your tool Take one last look Make sure that the tool works Check the tool information page Then, publish your tool

38 Your tool is published waiting for Contribution form User nanohub team Registered Created Uploaded Installed Updated If you want to make changes Approved Published Retired

39 Updating your tool waiting for Contribution form User nanohub team Registered Created Uploaded Installed Published Updated Approved We re-install your tool You approve it We take one last look Your changes are published Retired

40 Become a Contributor Don t let your code gather dust on the shelf. Get it out there! Promote your work on nanohub.org Upload your own: Tools Tutorials