Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 922 Bytes

README.md

File metadata and controls

23 lines (18 loc) · 922 Bytes

Analysis template repository

This contains the raw structure I usually use when doing single-cell/spatial data analysis. This template is based on ideas from Philipp Weiler's template repository as well as the scverse cookiecutter template.

Set up

  1. Rename src/fancypackage/.
  2. Update pyproject.toml to include the following information:
    • Project name
    • Project description
    • Project-specific Python requirements
    • Project author
    • Project maintainers
    • Project URLs
  3. Update src/fancypackage/ul/constants.py to include any paths relevant to your analysis and that should be accessible from any script or Jupyter notebook
  4. Update this README to include the relevant information about your project.

Installation

pip install -e ".[dev,test]"
pre-commit install