1

Uploading and Publishing New Tools

Michael McLennanSoftware Architect

HUBzero™ Platform for Scientific Collaboration

This work licensed underCreative Commons

See license online:by-nc-sa/3.0

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.

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?Hey, can you help me?

3

Access tools online

4

Start the upload process

5

Tool registration form

alpha123

Nice Tool Name

1.2.3a

It does this…

Who can run itWho can access code

Who can access wiki

Team members

6

Tool development process

Registered

Created

Uploaded

Installed Updated

Published

Retired

Contribution form

Approved

User Hub managers

waiting for…

Hub managers create a project area for your tool

• Wiki for project documentaton• Subversion source code control• Code change history

https://yourhub.org/tools

7

Your project area

NOTE: You may have to log in to see some buttons

Buttons to access project functions:• Wiki documentation• Source code• Timeline of changes

8

Editing wiki pages

Once logged in, you can edit

Wiki Markup

9

Wiki mark-up

Complete instructions in your project areaat wiki/WikiFormatting

10

Linking wiki pages

Click on any link? to create that page:

Any word with mixed case is treated as a link

11

What’s happening?

12

Know where you stand

13

Edit your tool information page

This is the page that people see when they find your tool on the hub

14

Know where you stand

15

Edit your tool settings

16

Putting out Open Source

your code

/* * ================================================= * AUTHOR: Michael McLennan * Copyright (c) 2010 Purdue University * * See the file "license.terms" for information on * usage and redistribution of this file, and for a * DISCLAIMER OF ALL WARRANTIES. * ================================================= */…

/* * ================================================= * AUTHOR: Michael McLennan * Copyright (c) 2010 Purdue University * * See the file "license.terms" for information on * usage and redistribution of this file, and for a * DISCLAIMER OF ALL WARRANTIES. * ================================================= */…

www.opensource.org license.terms

17

Uploading your code

Registered

Created

Uploaded

Installed Updated

Published

Retired

Contribution form

Approved

User Hub managers

waiting for…

Upload your code into a hub workspace. Compile, test, and commit changes back to your Subversion repository.

18

Uploading your code

Registered

Created

Uploaded

Installed Updated

Published

Retired

Contribution form

Approved

User Hub managers

waiting for…

Tool status page:http://yourhub.org/contribtool

19

Testing your tool

Registered

Created

Uploaded

Installed Updated

Published

Retired

Contribution form

Approved

User Hub managers

waiting for…

20

Testing your tool

Registered

Created

Uploaded

Installed Updated

Published

Retired

Contribution form

Approved

User Hub managers

waiting for…

21

Need help?

Registered

Created

Uploaded

Installed Updated

Published

Retired

Contribution form

Approved

User Hub managers

waiting for…

I need help!I need help!

Don’t send email!

22

Use the web interface to communicate

Message goesto the whole team,and is stored inthe history

23

Testing your tool—again

Registered

Created

Uploaded

Installed Updated

Published

Retired

Contribution form

Approved

User Hub managers

waiting for…

24

Last step…

Registered

Created

Uploaded

Installed Updated

Published

Retired

Contribution form

Approved

User Hub managers

waiting for…

Hub managers…• Take one last look• Make sure that the tool works• Check the tool information page• Then, publish your tool

25

Your tool is published

Registered

Created

Uploaded

Installed Updated

Published

Retired

Contribution form

Approved

User Hub managers

waiting for…

If you want to make changes…

26

Approved

Updating your tool

Registered

Created

Uploaded

Installed Updated

Published

Retired

Contribution formUser Hub managers

waiting for…

Re-install your toolYou approve itOne last lookYour changes are published

27

Promote your work by uploading/sharing

Become a Contributor

Don’t let your code gather dust on the shelf. Get it out there!

Upload your own:• Tools• Tutorials