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

Fixing Circular Definitions in Docs #699

Open
jeisenman23 opened this issue Oct 23, 2024 · 1 comment · May be fixed by #706
Open

Fixing Circular Definitions in Docs #699

jeisenman23 opened this issue Oct 23, 2024 · 1 comment · May be fixed by #706
Labels
documentation v0.7 (upcoming) version 0.7
Milestone

Comments

@jeisenman23
Copy link

Description

This was in the getting familiar with Calliope definitions. These definitions are self referential and relatively difficult to understand without real examples.

Current:
Technology: a technology that produces, consumes, converts or transports carriers.
Node: a site which can contain multiple technologies and which may contain other nodes for carrier balancing purposes.
Source: a source of commodity that can (or must) be used by a technology to introduce carriers into the system.
Sink: a commodity sink that can (or must) be used by a technology to remove carriers from the system.
Carrier: a carrier that groups technologies together into the same network, for example electricity or heat.

Also, what does "grouping technologies" mean? The example, "electricity or heat" does not constitute a grouping.

Related links

https://calliope.readthedocs.io/en/latest/creating/

Version

v0.7.0

Proposed change

I propose that each definition should not be self referential and also have a tangible example. One definition may be:

Technology: an entity that produces, consumes, converts or transports carriers.

  • You could, for instance, define a solar technology to produce, battery to cosume energy...
@brynpickering
Copy link
Member

Thanks @jeisenman23 !

I agree that examples would be worthwhile. Would a graphic like this also help?

image

@brynpickering brynpickering added the v0.7 (upcoming) version 0.7 label Oct 24, 2024
@brynpickering brynpickering added this to the 0.7.0 milestone Oct 24, 2024
@brynpickering brynpickering linked a pull request Nov 8, 2024 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation v0.7 (upcoming) version 0.7
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants