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

docs: How to describe the Map function? #155

Open
alhirzel opened this issue Aug 31, 2022 · 1 comment
Open

docs: How to describe the Map function? #155

alhirzel opened this issue Aug 31, 2022 · 1 comment

Comments

@alhirzel
Copy link
Contributor

I am a little confused on the difference between merging with the Map function versus the Model function. For instance, is Map only for assigning inputs and outputs whereas Model can add more equations? I didn't see a docstring for the functions and would like to add one once I understand the difference between them. In this thread, can anyone help me understand?

@MartinOtter
Copy link
Member

We will improve documentation. Conceptually, Map is for changing existing elements (e.g. parameters) and Model is for adding new elements (e.g. equations, or sub-components). Currently, Map and Model have identical definitions.

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

No branches or pull requests

2 participants