SymPy Guides

The SymPy Guide discusses common developer process required to get started, and contributing to the SymPy project. It includes sections on installation, developer setup, but also common code and documentation style guides. It also covers topic areas on booleans and the core assumptions module.

For a deeper and elaborate exploration of other SymPy topics, see the section Explanation and the API reference for a module break down.

• Getting Started
  • Installation
• Contributing to SymPy
  • Development Environment Setup
  • Build the Documentation
  • Debugging
  • SymPy Docstrings Style Guide
  • General Guidelines
  • Types of Documentation
  • Narrative Documentation Guidelines
  • Documentation using Markdown
  • Best Practices for Writing Documentation
  • Making a Contribution
• Assumptions
  • The (old) assumptions system
  • Gotcha: symbols with different assumptions
  • Applying assumptions to string inputs
  • Predicates
  • Implications
  • Interpretation of the predicates
  • Other is_* properties
  • Implementing assumptions handlers
  • Mechanism of the assumptions system
  • Limitations
  • New assumptions
• Symbolic and fuzzy booleans
  • Symbolic Boolean vs three valued bool
  • Three-valued logic with fuzzy bools
  • Three-valued logic with symbolic Booleans