Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/callaghanmt-training/swd3-demo

https://github.com/callaghanmt-training/swd3-demo

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: callaghanmt-training
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 2.64 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme License

README.md

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

Detailed Workflow

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

Owner

  • Name: callaghanmt-training
  • Login: callaghanmt-training
  • Kind: organization

GitHub Events

Total
Last Year

Dependencies

.github/workflows/python-lint-test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/sphinx-docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • peaceiris/actions-gh-pages v3 composite
setup.py pypi