Skip to content

Clarify some of the terminology around energy and activity#492

Merged
tsmbland merged 3 commits intomainfrom
clarify_energy_vs_activity
Apr 23, 2025
Merged

Clarify some of the terminology around energy and activity#492
tsmbland merged 3 commits intomainfrom
clarify_energy_vs_activity

Conversation

@tsmbland
Copy link
Copy Markdown
Collaborator

@tsmbland tsmbland commented Apr 23, 2025

Description

Pretty much everything that we're currently referring to as "activity" actually refers to an absolute/relative quantity of energy, rather than a rate of energy consumption/production. E.g. whilst the process_availabilities.csv file contains limits on rates of consumption/production in each timeslice, we multiply these by timeslice lengths to get limits on quantities of energy consumption/production. Therefore, a better name for the data structure is EnergyLimitsMap, rather than ActivityLimitsMap. I've changed this, and clarified a few other things.

I think we should use the term "activity" sparingly and only to refer to one specific thing: the maximum PAC production over a year (i.e. the value you get when you multiply capacity by cap2act).

I think the documentation is already specific enough about this, so I haven't changed anything there.

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change to fix an issue)
  • New feature (non-breaking change to add functionality)
  • Refactoring (non-breaking, non-functional change to improve maintainability)
  • Optimization (non-breaking change to speed up the code)
  • Breaking change (whatever its nature)
  • Documentation (improve or add documentation)

Key checklist

  • All tests pass: $ cargo test
  • The documentation builds and looks OK: $ cargo doc

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.03%. Comparing base (93384c2) to head (51a57ac).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #492   +/-   ##
=======================================
  Coverage   95.03%   95.03%           
=======================================
  Files          36       36           
  Lines        4914     4914           
  Branches     4914     4914           
=======================================
  Hits         4670     4670           
  Misses        123      123           
  Partials      121      121           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tsmbland tsmbland changed the title Clarify some of the language around energy and activity Clarify some of the terminology around energy and activity Apr 23, 2025
@tsmbland tsmbland marked this pull request as ready for review April 23, 2025 11:18
@tsmbland tsmbland requested a review from alexdewar April 23, 2025 11:18
Copy link
Copy Markdown
Member

@alexdewar alexdewar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of small comments, but otherwise all good 😄

Comment thread src/asset.rs
Comment thread src/asset.rs Outdated
id: "process1".into(),
description: "Description".into(),
activity_limits,
energy_limits: activity_limits,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this variable name needs changing too?

@tsmbland tsmbland enabled auto-merge April 23, 2025 12:02
@tsmbland tsmbland merged commit 28972b7 into main Apr 23, 2025
7 checks passed
@tsmbland tsmbland deleted the clarify_energy_vs_activity branch April 23, 2025 12:05
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

Successfully merging this pull request may close these issues.

2 participants