Developer documentation
This section provides guidance for developers and contributors to PowerModelsACDC. It records the design decisions that shape the package, explains the rationale behind them, and describes the conventions to follow when extending the codebase. It is intended to evolve alongside the project and serve as a shared reference for maintaining a consistent and maintainable implementation.
This section is a living document. It will be expanded and refined as development practices and design decisions are documented.
Unit tests
- Add test sets to a file named after the unit they test, such as a specific network component or optimization problem.
- Use this hierarchy for organizing test sets:
- Network component or optimization problem under test.
- Specific feature or implementation, if there is more than one.
- Network model, if the feature or implementation depends on it.
- Test case, if there is more than one.
- If a test case is used in multiple related test sets, load it only once before those test sets.
- Always test the termination status. This helps debug failing tests.