This repository is a template for creating new repositories containing
code that will run on mSCAPE. It serves as a guide for code layout
and files will need amending to fit the repo purpose.
As a minimum, mSCAPE repositories should include the following:
- Code to be in src/ layout
- tests/ folder at same level as src/
- .github/ folder containing workflows and a pull request template
- .gitignore file
- pyproject.toml file
- .pre-commit-hooks.yaml
This repo follows the above structure and contains examples of the files
referenced above.
A ssuggested layout for repo READMEs is included below. The guidance
documentation contains further information on required repository
structure, development cycles, and making pull requests. Please read
this guidance document before using the template.
Brief description of project here
Add installation instructions here. Ideally include commands to make
the process as easy as possible for users.
Clone repo and create environment:
git clone git@github.com:ukhsa-collaboration/mscape-template.git
conda env create -n mscape_template
conda activate mscape_template
Installation for users:
cd mscape-template
pip install .
Installation for developers (installs code in editable mode):
cd mscape-template
pip install --editable '.[dev]'
Include command line arguments (e.g. the output displayed when using -h)
for reference. Example commands can also be helpful.
Add other sections as appropriate for your repo. This may include
instructions on updating the repo, instructions on adding new
references, troubleshooting etc.