PowerSimulations.jl
PowerSimulations.jl copied to clipboard
Document and export public API for Type 2 "Model Developer" users
It'd be good if we could come up with a list, so we know what functions/types etc. should have docstrings add/updated and become user-facing (for "Type 2" users). (Note that adding exports is not breaking)
Here's an initial list of what we think should be public API (exported and docstrings):
- [x] AbstractDeviceFormulation,
- [ ] ActivePowerVariable,
- [ ] add_cons_container!,
- [ ] AddVariableSpec,
- [ ] add_variables!,
- [ ] DeviceRangeConstraintInfo,
- [ ] encode_symbol,
- [ ] get_component_name,
- [ ] make_constraint_name,
- [ ] make_variable_name,
- [ ] middle_rename,
- [ ] model_time_steps,
- [ ] OnVariable,
- [ ] PSIContainer,
- [ ] PSI_NAME_DELIMITER,
- [ ] RangeConstraint,
- [ ] RangeConstraintSpecInternal,
- [ ] validate_available_devices,
- [ ] VariableType,
- [ ] AbstractReservesFormulation,
- [ ] model_has_parameters,
- [ ] service_requirement_constraint!
What else should be on the list? (and what shouldn't ?)
Thanks @nickrobinson251 for the suggestion.
PowerModels Formulation types