search

EnergySystemsModellingLab / MUSE_2.0

Welcome to the MUSE 2.0 repository
GNU General Public License v3.0
1 stars 0 forks source link

Use consistent casing for enum-type fields in CSV files #120

Closed alexdewar closed 3 months ago

alexdewar commented 4 months ago 
          All the various IDs (e.g. for agents too etc.) seem to be in uppercase, but there's no reason they have to be from the perspective of the code (insofar as we're actually using any of them).

Not sure why type and timeslice_level are in uppercase, but that's how things are described in @ahawkes and @tsmbland's documents.

Personally, I think these should be lowercase -- we have other "enum-type" fields in other files that are -- but either way we should probably be consistent. We want to read in these values in a case-insensitive way (that's what I've done with the enum types in this PR), so it won't matter from the code's perspective, but let's be consistent in our examples/documentation.

Is everyone happy with this?

_Originally posted by @alexdewar in https://github.com/EnergySystemsModellingLab/MUSE_2.0/pull/105#discussion_r1682489060_

ahawkes commented 4 months ago

Yes change to lowercase here is fine. We'll need to check what these values are in the code for commodity balance constraints, and it should work regardless of what case the user enters them in.

From: Alex Dewar @.> Sent: 18 July 2024 11:33 To: EnergySystemsModellingLab/MUSE_2.0 @.> Cc: Hawkes, Adam D @.>; Mention @.> Subject: [EnergySystemsModellingLab/MUSE_2.0] Use consistent casing for enum-type fields in CSV files (Issue #120)

This email from @.*** originates from outside Imperial. Do not click on links and attachments unless you recognise the sender. If you trust the sender, add them to your safe senders listhttps://spam.ic.ac.uk/SpamConsole/Senders.aspx to disable email stamping for this address.

      All the various IDs (e.g. for agents too etc.) seem to be in uppercase, but there's no reason they have to be from the perspective of the code (insofar as we're actually using any of them).

Not sure why type and timeslice_level are in uppercase, but that's how things are described in @ahawkeshttps://github.com/ahawkes and @tsmblandhttps://github.com/tsmbland's documents.

Personally, I think these should be lowercase -- we have other "enum-type" fields in other files that are -- but either way we should probably be consistent. We want to read in these values in a case-insensitive way (that's what I've done with the enum types in this PR), so it won't matter from the code's perspective, but let's be consistent in our examples/documentation.

Is everyone happy with this?

Originally posted by @alexdewarhttps://github.com/alexdewar in #105 (comment)https://github.com/EnergySystemsModellingLab/MUSE_2.0/pull/105#discussion_r1682489060

— Reply to this email directly, view it on GitHubhttps://github.com/EnergySystemsModellingLab/MUSE_2.0/issues/120, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AC37JLJHUFTZQ3EZ26KVFNTZM6KWHAVCNFSM6AAAAABLCMJT2KVHI2DSMVQWIX3LMV43ASLTON2WKOZSGQYTMMBRGA4DENY. You are receiving this because you were mentioned.Message ID: @.***>