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 special sensor/asset attributes #853

Open
Flix6x opened this issue Sep 14, 2023 · 2 comments
Open

Document special sensor/asset attributes #853

Flix6x opened this issue Sep 14, 2023 · 2 comments

Comments

@Flix6x
Copy link
Contributor

Flix6x commented Sep 14, 2023

We use a few specifically named sensor attributes and asset attributes in various places of the code, which we'd like to document. Let's start a list here and decide where/how we document them.

@nhoening
Copy link
Contributor

@victorgarcia98 any other attributes we use coming to mind?

@victorgarcia98
Copy link
Contributor

victorgarcia98 commented Sep 15, 2023

Good idea!

I've looked into the code searching for attributes[ and get_attributes( strings and I found the following:

Asset attributes

Sensor attributes

  • soc_datetime
  • soc_in_mwh
  • roundtrip_efficiency
  • min_soc_in_mwh
  • max_soc_in_mwh
  • is_strictly_non_positive
  • is_strictly_non_negative
  • capacity_in_mw
  • is_consumer
  • is_producer
  • sensor_type
  • process-type
  • consumption_is_positive
  • market_id
  • custom-scheduler
  • interpolate Feat/interpolate instantaneous sensor charts #851

These fall back to using an asset column, rather than a field of the asset attributes column:

  • latitude
  • longitude

Data Source attributes

  • data_generator

Note: I tried to put the attributes that are retrieved with the get_attributes method in the list that made most sense to me but without considering it deeply. Feel free to edit this comment to sort them out.

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

3 participants