Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@

## Bug fixes

- Solves broken links in the documentation ([#137](https://github.com/SGIModel/MUSE_OS/pull/137))
- NPV fails to align timeslices ([#135]https://github.com/SGIModel/MUSE_OS/pull/135)
- OS case studies had obsolete output function removed ([#101]https://github.com/SGIModel/MUSE_OS/pull/101)
- Growth constraints with destination and source region ([#96](https://github.com/SGIModel/MUSE_OS/pull/96))
Expand Down
237 changes: 0 additions & 237 deletions docs/advanced-guide/api.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/advanced-guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Advanced guide

extending-muse
further-extending-muse
api



3 changes: 0 additions & 3 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,6 @@ Reading the inputs
Writing Outputs
---------------

.. automodule:: muse.outputs
:members:

Sinks
~~~~~

Expand Down
2 changes: 1 addition & 1 deletion docs/inputs/agents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Agents
======

In MUSE, an agent-based formulation was originally introduced for the residential and
commercial building sectors :cite:`2019:sachs`. Agents are defined using a CSV file, with
commercial building sectors (`Sachs et al. (2019) <https://doi.org/10.1016/j.energy.2019.01.161>`_). Agents are defined using a CSV file, with
one agent per row, using a format meant specifically for retrofit
and new-capacity agent pairs. This CSV file can be read using
:py:func:`~muse.readers.csv.read_csv_agent_parameters`. The data is also
Expand Down
2 changes: 1 addition & 1 deletion docs/inputs/commodities_io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ Unit
The input data has to be provided for the base year. Additional years within the time
framework of the overall simulation can be defined. In this case, MUSE would interpolate
the values between the provided periods and assume a constant value afterwards. The additional
years at which input data are defined needs to equal for :ref:`inputs-iocomms`, :ref:`inputs-technodata`, and :ref:`inputs-technodata-ts`.
years at which input data for input/output commodities, are defined needs to equal for :ref:`inputs-technodata` and :ref:`inputs-technodata-ts`.

Interpolation is activated only if the feature *interpolation_mode = 'Active'* is defined in the TOML file.
1 change: 0 additions & 1 deletion docs/inputs/inputs_csv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Input Files
commodities
technodata
technodata_timeslices
timeslices
commodities_io
existing_capacity
agents
Expand Down
4 changes: 2 additions & 2 deletions docs/inputs/technodata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Agent_0, ..., Agent_N
The value corresponds to the ownership of the initial stock, as defined in the :ref:`inputs-existing-capacity` for the starting year of the simulation.
For example, if an initial boiler stock of 10 PJ is available, this is allocated to each agent according to the "AgentShare".

In a one-agent simulation, assuming that the *AgentShare* equals to *Agent_2" for the retrofit agent, the technodata should indicate the stock ownership as follows.
In a one-agent simulation, assuming that the *AgentShare* equals to *Agent_2* for the retrofit agent, the technodata should indicate the stock ownership as follows.
The modelled agent would own the total 10 PJ of the initial stock of boilers.

.. csv-table:: Techno-data: AgentShare - 1 agent
Expand All @@ -169,6 +169,6 @@ Agent_0, ..., Agent_N
The input data has to be provided for the base year. Additional years within the time
framework of the overall simulation can be defined. In this case, MUSE would interpolate
the values between the provided periods and assume a constant value afterwards. The additional
years at which input data are defined needs to equal for :ref:`inputs-iocomms`, :ref:`inputs-technodata`, and :ref:`inputs-technodata-ts`.
years at which input data for techno-data are defined need to equal for :ref:`inputs-iocomms` and :ref:`inputs-technodata-ts`.

Interpolation is activated only if the feature *interpolation_mode = 'Active'* is defined in the TOML file.
2 changes: 1 addition & 1 deletion docs/inputs/technodata_timeslices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ MinimumServiceFactor
The input data has to be provided for the base year. Additional years within the time
framework of the overall simulation can be defined. In this case, MUSE would interpolate
the values between the provided periods and assume a constant value afterwards. The additional
years at which input data are defined needs to equal for :ref:`inputs-iocomms`, :ref:`inputs-technodata`, and :ref:`inputs-technodata-ts`.
years at which input data for techno-data timeslices, need to equal those for :ref:`inputs-iocomms` and :ref:`inputs-technodata`.

Interpolation is activated only if the feature *interpolation_mode = 'Active'* is defined in the TOML file.
Loading