Development Guide

Contributions to freud are highly encouraged. The pages below offer information about how the project is structured, the goals of the freud library, and how to contribute new modules.

• Design Principles
  • Vision
  • Language choices
  • Unit Tests
  • Benchmarks
  • Make Execution Explicit
  • Code Duplication
  • Python vs. Cython vs. C++
• Contributing to freud
  • Code Conventions
  • Code Organization
  • Steps for Adding New Code
• Special Topics
  • Memory Management
  • Neighbor Finding
  • Histograms
• Making freud Releases
  • Release Process