Welcome to the documentation of the OSIS Reproducability Python Template!

Contents:

• src
  • src package
• src package
  • Submodules
  • src.config module
  • src.data module
  • src.model module
  • src.utils module

This Project contains an example python package for the Advanced Reproducibility Workshop (OSIS).

Introduction

Hi there! Here is the right place for a brief introduction to the project. The Documentation is available here.

The random project logo was created with Stable Diffusion 2 (Rombach et al., 2022).

Installation

• Setup a virtual environment with python -m venv venv

• Activate the virtual environment with source venv/bin/activate

• Install the project with poetry poetry install (Have poetry installed)

Usage

Populate this section with instructions on how to use the project.

Development Setup

• Install pre-commit hooks with pre-commit install

• Run tests with unittest with python -m unittest discover -s tests

Contribution Guidelines

Populate this section with guidelines on how to contribute to the project.

Citation

If you use this project, please cite it as follows:

@misc{osisPyRepr2024,
  author = {Emanuel Sommer and Tobias Weber and Lisa Wimmer},
  title = {Advanced Reproducibility Workshop - Python Package Template},
  year = {2024},
}

License

This project is licensed under the MIT License - see the LICENSE file for details.