🔧 Setup tooling and CI infrastructure 🚇

[jsnel]

Setting up tooling and CI infrastructure

Description

This repository will contain notebooks and/or (supporting) scripts which should be executable to provide some form of output (a figure or a notebook which can be rendered as PDF or displayed (previewed) in a browser). New examples will be added through pull-requests to this repository, which means we need to have some infrastructure in place to automatically check new code added (does it run, does it produce output, is the code style ok).

To test the CI I suggest that either in the same PR, or in a follow-up PR, we add a TEMPLATE, _template, naming things is hard, folder which contains a sample directory structure which can be checked by the CI. This idea is a notebook + basic supporting script (which generates simulated data to be fitted), a data folder containing a dataset.

Requirements

Core actions

• pre-commit.ci
• Tests ?

Code runners:

• Run Notebooks / Run Notebook:

Optional (appropriate ones):

• Codeowners Validator (add a codeowner per publication project folder)
• Codacy Static Code Analysis
• LGTM analysis: Python
• SonarCloud Code Analysis
• Sourcery

Proposed repository layout:

• README, LICENSE, etc
• TEMPLATE
  • data
    • data.ascii
  • notebook.ipynb
  • (notebook_n.ipynb)
  • (supporting_script.py)
• 2021
  • following structure in TEMPLATE