`hypot`: The SWD3 Demo Software

Repository to demo the SWD3 course workflow. The course incorporates several good practices and approaches to develop a software.

We use the Hypotenuse problem as simple problem. The general design is

1 squared function
1 sum function
1 square root function
1 hypotenuse function that uses the other functions

Related Material

Slides used in this course
Complete RSE Course Material

Detailed Workflow

Local Setup: Install Git, Anaconda, VScode
Git Initialisation: Create a GitHub repository + Licence + .gitignore + Readme
GH Action Setup: GH Action for testing (Python application)
Working locally: Clone GH repository in local machine
Structure: Create project structure (source and test folders)
Test Driven Development: Setup tests
Development: write code
Simple Documentation: Add docstring (you can use autoDocstring - Python Docstring Generator on VS Code)
Deployment: Push to github
Advanced documentation: Create documentation using Sphinx and GH Action/Page
Local Install: Setup file and local installation
Release: Create a GitHub Release