Make software executable by others - Revision history

Yolanda at 21:13, 7 May 2015

2015-05-07T21:13:52Z

2015-05-07T21:07:16Z

‎Training Materials

2015-04-30T18:49:10Z

Set PropertyValue: Progress = 20

2015-04-30T18:47:31Z

2015-04-30T18:47:13Z

‎What To Do

2015-04-30T18:46:57Z

‎Training Materials

2015-04-26T18:37:04Z

Added PropertyValue: Participants = varun ratnakar

2015-04-17T05:18:15Z

Set PropertyValue: StartDate = 2015-04-18

2015-04-17T05:17:56Z

Set PropertyValue: TargetDate = 2015-05-01

2015-04-03T20:50:47Z

Set PropertyValue: Progress = 0

@@ Line 2: / Line 2: @@
 == What This Task Involves ==
 There are a few simple things that you can do to make your code more usable by others.  Here are a few suggestions:
@@ Line 11: / Line 22: @@
 * Scan your code for hardcoded paths, or paths specified in a format that is dependent on the underlying OS.  For example, a path that is specified as Users/JohnSmith/mycode/main.py will make the code dependent on that directory existing in the file system.  Change those to make them parameters.
-* If your code has runtime dependencies make notes about them.  For example, if your code depends on a  certain R library make sure you specify what it is and how to find it.
+* If your code has runtime dependencies make notes about them.  For example, if your code depends on a certain R library make sure you specify what it is and how to find it.
-* Write some documentation describing how the code should be invoked, its function, what assumptions it makes, any limitations of its use
+* Use ''build automation software'' (e.g., make, maven, etc) to compile your code, so that dependencies are tracked
-== Training Materials ==
+* Write your code so that it gives informative messages to users when an error occurs and returns a proper failure exit code
 <!-- Add any wiki Text above this Line -->

@@ Line 19: / Line 19: @@
 This training session was held on April 17, 2015:
-* '''[https://www.dropbox.com/s/7fd53wr292x2w83/MakingSoftwareExecutableByOthers.pdf?dl=0 Presentation]'''
+* '''[https://www.dropbox.com/s/7fd53wr292x2w83/MakingSoftwareExecutableByOthers.pdf?dl=0 Presentation: Making your software executable by others]'''
 <!-- Add any wiki Text above this Line -->

@@ Line 27: / Line 27: @@
 	Owner=Yolanda_Gil|
 	Participants=Varun_ratnakar|
-	Progress=0|
+	Progress=20|
 	StartDate=2015-04-18|
 	TargetDate=2015-05-01|
 	Type=Low}}

@@ Line 14: / Line 14: @@
 * Write some documentation describing how the code should be invoked, its function, what assumptions it makes, any limitations of its use
 == Training Materials ==
@@ Line 21: / Line 20: @@
 * '''[https://www.dropbox.com/s/7fd53wr292x2w83/MakingSoftwareExecutableByOthers.pdf?dl=0 Presentation]'''
 <!-- Add any wiki Text above this Line -->

← Older revision		Revision as of 18:47, 30 April 2015
Line 21:		Line 21:

	* '''[https://www.dropbox.com/s/7fd53wr292x2w83/MakingSoftwareExecutableByOthers.pdf?dl=0 Presentation]'''		* '''[https://www.dropbox.com/s/7fd53wr292x2w83/MakingSoftwareExecutableByOthers.pdf?dl=0 Presentation]'''
−
−	~~== What To Do ==~~
−
−	* TBD

@@ Line 18: / Line 18: @@
 == Training Materials ==
-This training session was held on March 6, 2015:
+This training session was held on April 17, 2015:
-* '''Presentation -- to be posted'''
+* '''[https://www.dropbox.com/s/7fd53wr292x2w83/MakingSoftwareExecutableByOthers.pdf?dl=0 Presentation]'''
-−
-=== Suggested Readings ===
-−
-* TBD
 == What To Do ==

@@ Line 36: / Line 36: @@
 	Expertise=Open_science|
 	Owner=Yolanda_Gil|
-	Progress=10|
+	Progress=0|
 	StartDate=2015-03-20|
 	TargetDate=2015-04-03|
 	Type=Low}}