Skip to content

Small README improvements #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
irm-codebase merged 2 commits into from
Apr 2, 2026
Merged

Small README improvements #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e97db7
readme reshuffle
irm-codebase Apr 2, 2026
4cce1f4
update release workflow permissions
irm-codebase Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions template/.github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ on:

jobs:
release-workflow:
permissions:
contents: write
uses: modelblocks-org/data-module-template/.github/workflows/template-release.yml@latest
49 changes: 26 additions & 23 deletions template/README.md.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,34 @@

{{module_description}}

## About this module
<!-- Place an attractive image of module outputs here -->


## About
<!-- Please do not modify this templated section -->

This is a modular `snakemake` workflow built for [Modelblocks](https://www.modelblocks.org/) data modules.
This is a modular `snakemake` workflow created as part of the [Modelblocks project](https://www.modelblocks.org/). It can be imported directly into any `snakemake` workflow.

For more information, please consult the Modelblocks [documentation](https://modelblocks.readthedocs.io/en/latest/),
the [integration example](./tests/integration/Snakefile),
and the `snakemake` [documentation](https://snakemake.readthedocs.io/en/stable/snakefiles/modularization.html).

## Overview
<!-- Please describe the processing stages of this module here -->

Data processing steps:
1.
2.

## Configuration
<!-- Please describe how to configure this module below -->

Please consult the configuration [README](./config/README.md) and the [configuration example](./config/config.yaml) for a general overview on the configuration options of this module.

## Input / output structure
<!-- Please describe input / output file placement below -->

This module can be imported directly into any `snakemake` workflow.
For more information, please consult:
- The Modelblocks [documentation](https://modelblocks.readthedocs.io/en/latest/).
- The integration example in this repository (`tests/integration/Snakefile`).
- The `snakemake` [documentation on modularisation](https://snakemake.readthedocs.io/en/stable/snakefiles/modularization.html).
Please consult the [interface file](./INTERFACE.yaml) for more information.

## Development
<!-- Please do not modify this templated section -->
Expand Down Expand Up @@ -39,22 +57,7 @@ cd tests/integration/ # navigate to the integration example
snakemake --use-conda --cores 2 # run the workflow!
```

## Documentation

### Overview
<!-- Please describe the processing stages of this module here -->

### Configuration
<!-- Feel free to describe how to configure this module below -->

Please consult the configuration [README](./config/README.md) and the [configuration example](./config/config.yaml) for a general overview on the configuration options of this module.

### Input / output structure
<!-- Feel free to describe input / output file placement below -->

Please consult the [interface file](./INTERFACE.yaml) for more information.

### References
## References
<!-- Please provide thorough referencing below -->

This module is based on the following research and datasets:
Expand Down
Loading