Development Guide

Contributions to freud are highly encouraged. The pages below offer information about freud’s design goals and how to contribute new modules.

• Design Principles
  • Vision
  • Language choices
  • Unit Tests
  • Benchmarks
  • Make Execution Explicit
  • Code Duplication
  • Python vs. Cython vs. C++
• Source Code Conventions
  • Naming Conventions
  • Indentation
  • Python
  • C++
• How to Add New Code
  • Does my code belong in freud?
  • Create a new branch
  • Add a New Module
  • Add to an Existing Module