template_project Logo

Getting started

  • Getting Started: Setup and Installation
  • Customisation Checklist for New Projects
  • What’s in This Template Project?
  • 📁 template-project File Structure

GitHub basics

  • Getting Started with GitHub
  • GitHub Tags for Oceanographic Projects
  • Solo Git Workflow for Your Project
  • Collaborating on Someone Else’s Repository

Development Guide

  • Project Style Guide
  • Writing and Running Tests
  • Building Documentation Locally
  • Setting Up Pre-commit Hooks
  • GitHub Actions: Automating Your Project

Project Management

  • How to Cite This Project
  • Publishing Your Project to PyPI
  • Transferring a Repository to an Organisation

Users' guide

  • template-project demo

Help and reference

  • GitHub Repo
  • template_project API
  • FAQ / Troubleshooting
template_project
  • Index

Index

A | C | D | G | L | M | P | R | S | T

A

  • apply_defaults() (in module template_project.utilities)

C

  • convert_units_var() (in module template_project.tools)

D

  • download_file() (in module template_project.utilities)

G

  • get_default_data_dir() (in module template_project.utilities)

L

  • load_dataset() (in module template_project.readers)
  • load_sample_dataset() (in module template_project.readers)

M

  • module
    • template_project.plotters
    • template_project.readers
    • template_project.tools
    • template_project.utilities
    • template_project.writers

P

  • plot_monthly_transport() (in module template_project.plotters)

R

  • reformat_units_var() (in module template_project.tools)
  • resolve_file_path() (in module template_project.utilities)

S

  • safe_update_attrs() (in module template_project.utilities)
  • save_dataset() (in module template_project.writers)
  • show_attributes() (in module template_project.plotters)
  • show_variables() (in module template_project.plotters)

T

  • template_project.plotters
    • module
  • template_project.readers
    • module
  • template_project.tools
    • module
  • template_project.utilities
    • module
  • template_project.writers
    • module

© Copyright 2025, Eleanor Frajka-Williams, FirstName LastName.

Built with Sphinx using a theme provided by Read the Docs.