Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document and export public API for Type 2 "Model Developer" users #520

Open
1 of 22 tasks
andrewrosemberg opened this issue Sep 2, 2020 · 1 comment · May be fixed by #1143
Open
1 of 22 tasks

Document and export public API for Type 2 "Model Developer" users #520

andrewrosemberg opened this issue Sep 2, 2020 · 1 comment · May be fixed by #1143

Comments

@andrewrosemberg
Copy link

andrewrosemberg commented Sep 2, 2020

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):

  • 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.

@andrewrosemberg
Copy link
Author

PowerModels Formulation types

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants