Skip to content

Update documentation for demand_share parameter #433

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 3 commits into from
Jul 29, 2024
Merged

Update documentation for demand_share parameter #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b40631
Brush up documentation
tsmbland Jul 26, 2024
2ec0912
Fix alignment
tsmbland Jul 26, 2024
d01ed8b
Revert change to trade model
tsmbland Jul 26, 2024
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
23 changes: 11 additions & 12 deletions docs/inputs/toml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,18 +518,17 @@ to define the timeslice simply by referring to the slices it will use at each le

*demand_share*
A method used to split the MCA demand into separate parts to be serviced by
specific agents. A basic distinction is between *new* and *retrofit* agents: the
former asked to respond to an increase of commodity demand investing in new
assets; the latter asked to invest in new asset to balance the decommissined
assets.

There are currently two options:

- :py:func:`~muse.demand_share.new_and_retro`: the demand is split into a
retrofit demand corresponding to demand that used to be serviced by
decommisioned assets, and the *new* demand.
- :py:func:`~muse.demand_share.market_demand`: simply the consumption for the
forecast year.
specific agents. The appropriate choice depends on the type of agents being used
in the simulation. There are currently two options:

- :py:func:`~muse.demand_share.standard_demand` (default): The input demand is
split amongst *new* agents. *New* agents get a share of the increase in demand
for the forecast years, as well as the demand that occurs from decommissioned
assets.
- :py:func:`~muse.demand_share.new_and_retro`: The input demand is split amongst
both *new* and *retrofit* agents. *New* agents get a share of the increase in
demand for the forecast year, whereas *retrofit* agents are assigned a share
of the demand that occurs from decommissioned assets.

*constraints*
The list of constraints to apply to the LP problem solved by the sector. By
Expand Down
12 changes: 6 additions & 6 deletions src/muse/demand_share.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ def demand_share(
return cast(DEMAND_SHARE_SIGNATURE, demand_share)


@register_demand_share(name="default")
@register_demand_share(name="new_and_retro")
def new_and_retro(
agents: Sequence[AbstractAgent],
market: xr.Dataset,
Expand All @@ -118,9 +118,9 @@ def new_and_retro(
) -> xr.DataArray:
r"""Splits demand across new and retro agents.

The input demand is split amongst both *new* and *retro* agents. *New* agents get a
share of the increase in demand for the forecast year, whereas *retrofi* agents are
assigned a share of the demand that occurs from decommissioned assets.
The input demand is split amongst both *new* and *retrofit* agents. *New* agents get
a share of the increase in demand for the forecast year, whereas *retrofit* agents
are assigned a share of the demand that occurs from decommissioned assets.

Args:
agents: a list of all agents. This list should mainly be used to determine the
Expand Down Expand Up @@ -318,7 +318,7 @@ def decommissioning(capacity):
return result


@register_demand_share(name="standard_demand")
@register_demand_share(name="default")
def standard_demand(
agents: Sequence[AbstractAgent],
market: xr.Dataset,
Expand All @@ -330,7 +330,7 @@ def standard_demand(
r"""Splits demand across new agents.

The input demand is split amongst *new* agents. *New* agents get a
share of the increase in demand for the forecast years well as the demand that
share of the increase in demand for the forecast years, as well as the demand that
occurs from decommissioned assets.

Args:
Expand Down