Developer’s Guide

This section serves as a guide for people who would like to add functionality to this project. If that is not your desire, this chapter can be skipped without any loss of comprehension.

Note

Developers are encouraged to read and follow new guiding principles in Updated Data Model leading up to verison 0.10.0

Contents:

• Contributing
  • Scope
  • Issues
  • Pull Requests
• Updated Data Model
  • Goals and non-goals
  • Data Model
  • Proposed integration
  • Release Targets
• Documentation
  • Docstrings
  • Examples
  • Verifying
  • Adding Objects to API
• Pull Request Checklist
  • CI Testing
  • Lint
• Version Control
  • Releases
  • Commit Messages
• Logging and Reporting
  • Developer Reference
  • Decorators
  • Custom Handlers
• Coding Style
• Plotting
  • Plotting Utilities
• Converter Utilites
• Parsing Engines
  • serpentTools.engines.KeywordParser
  • serpentTools.engines.PatternReader
• Adding Support for Serpent Versions
  • Checklist
  • New Variables
  • Versions with New File Formats
• Comparison Methods
  • Use of messaging module
  • High-level Logging and Comparison Utilities
  • Low-level Logging Utilities
• Data Model
  • Readers
  • Containers