Link to this document's Jupyter Notebook

Project Part 1: Software Exploration

In this milestone you will provide an example folder in your git repository with installation instructions and example files in a compact format which will allow your instructor and your peers to run the software you you choose to evaluate in your project proposal. There are four basic things you need to provide with this milestone project:

  1. Software Abstract
  2. Installation
  3. Example Code
  4. Submission script
  5. References

1. Software Abstract

✅ Create an example directory with a logical name relating to the program you evaluated. Include this directory in your github repository. Inside the directory add a README.md file and include a short description about the software you evaluated and how it is used in science and engineering. Is this a programming tool, some sort of "middle wear" or an application?

2. Installation

✅ In the README.md file (after the abstract) provide step-by-step instructions for installing the software on the HPCC. Include all commands, instructions or submission scripts that will allow your instructor and peers to install and use the software on themselves.

3. Example Code

✅ Provided small example data, scripts and instructions to run the code from within your example directory. These instructions should be detailed enough for a future student to be able to read the README.md file to get the software up and running. If possible provide these instructions similar to the GetExamples you saw in class. Ideally this example should take no more than 5 minutes to run so individuals testing the code can get an idea how it works.

4. Submission script

✅ Include a submission script for getting the code to run using the batch scheduler. Try to use the sb extension and properly comment the script.

5. References

At the end of the README.md file, provide a list of references and links for where you got the examples and any additional resources someone may need.

✅ Congratulations, you are done!

Now, you just need to submit this report by adding files to your git repository and pushing those files to the central repository. You instructor should already have your git repository and be able to pull in your changes.

Written by Dr. Dirk Colbry, Michigan State University Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.