Skip to content

Add deprecation warning about retrofit agents #693

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.

Sign up for GitHub

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

Merged
tsmbland merged 1 commit into from
Mar 31, 2025
Merged

Add deprecation warning about retrofit agents #693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/inputs/agents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Type
technologies. If only "New" agents are included, they will also invest to make up for
decommissioned assets, but the end mix might be different than using a specialised
"Retrofit" agent for that.
*Note: Retrofit agents will be deprecated in a future release.*

AgentShare
Name used to assign a fraction of existing capacity to the agent in the :ref:`inputs-technodata` file.
Expand Down
11 changes: 11 additions & 0 deletions src/muse/readers/csv.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,6 +482,8 @@ def read_csv_agent_parameters(filename) -> list:
Returns a list of dictionaries, where each dictionary can be used to instantiate an
agent in :py:func:`muse.agents.factories.factory`.
"""
from logging import getLogger

from muse.readers import camel_to_snake

if (
Expand Down Expand Up @@ -534,6 +536,15 @@ def read_csv_agent_parameters(filename) -> list:
"agent": "agent",
"default": "agent",
}[getattr(row, "Type", "agent").lower()]

# Add warning about retrofit agents
if agent_type == "retrofit":
msg = (
"Retrofit agents will be deprecated in a future release. "
"Please modify your model to use only agents of the 'New' type."
)
getLogger(__name__).warning(msg)

data = {
"name": row.Name,
"region": row.RegionName,
Expand Down