Research software development tutorials
latest

Contents:

  • Beginner tutorials
    • 1. The Linux terminal
    • 2. Programming languages
    • 3. Software development environments
    • 4. Managing source code
    • 5. Documenting software projects
    • 6. Testing code
    • 7. Best practices
  • Intermediate tutorials
  • Advanced tutorials (TBC)
  • FAQs and Tips
  • Contributing (TBC)
Research software development tutorials
  • »
  • Beginner tutorials
  • Edit on GitHub

Beginner tutorials

Contents:

  • 1. The Linux terminal
    • 1.1. Tips
    • 1.2. Commonly used commands
    • 1.3. Environmental variables
    • 1.4. Adding program locations to your PATH environmental variable
    • 1.5. Editing terminal start up scripts
    • 1.6. Identifying running processes
    • 1.7. Killing processes
  • 2. Programming languages
    • 2.1. Python
    • 2.2. Matlab
  • 3. Software development environments
    • 3.1. IDEs
    • 3.2. Using IDEs in containers
  • 4. Managing source code
    • 4.1. Version Control
    • 4.2. Educational accounts for Github and Gitkraken
    • 4.3. References
  • 5. Documenting software projects
    • 5.1. Writing effective documentation
    • 5.2. Languages
    • 5.3. Documentation generation tools
    • 5.4. Creating new documentation with Sphinx
    • 5.5. Hosting documentation
    • 5.6. Updating documentation
    • 5.7. Documenting source code (TBC)
  • 6. Testing code
    • 6.1. Introduction
    • 6.2. Python testing frameworks
  • 7. Best practices
    • 7.1. Directory setup
    • 7.2. Development process
    • 7.3. Replicability (TBC)
    • 7.4. Reproducibility (TBC)
    • 7.5. Additional resources
Previous Next

© Copyright 2021, Auckland Bioengineering Institute. Revision 645f98df.

Built with Sphinx using a theme provided by Read the Docs.