Welcome to Particles in box demo’s documentation!

This is an example project to show how to set up scientific computing python projects.

In the demo we will go through:

• Basics of git

• Unit testing with pytest

• Pre-commit hooks

• Setting up simple continuous development pipeline

• Making project documentation with Sphinx

• Publishing documentation in readthedocs.io

Contents:

• Instructions to run the particle in box demo
• Documentation
  • particle.py
  • simulation.py

Indices and tables

• Index

• Module Index

• Search Page