section topics ideas

[slayoo]

• code management:
  • organising a git repo
  • work with advisors, peer reviewers and collaborators
  • tags, releases, semantic versioning
  • persistent archival on Zenodo, DOI
  • packaging (pyproject.toml, etc)
  • automation with pre-commit hooks
  • automation with GitHub actions (e.g., spell check, running tests, ...)
• notebooks, figures and tables:
  • vector graphics
  • animations
  • code listings
  • diagrams
  • tables with in-notebook computations output
  • 3D scenes using PyVista
  • automation: nbqa, GitHub artifacts, testing notebook contents
• typesetting:
  • in-text references
  • bibliography
  • AGH title page
  • including computed values in the text
  • avoiding windows, orphans, etc
  • Quarto
  • automation: Quarto actions
• legal:
  • licensing code
  • licensing content
  • copyright
• documenting:
  • setting up execution on Colab and mybinder.org
  • creating slides for a defense
  • publishing on arXiv and alike
  • code-based docs
  • automation: publishing docs