Skip to content

Commit

Permalink
Merge pull request #782 from blue-marble/develop
Browse files Browse the repository at this point in the history
GridPath v0.9.0
  • Loading branch information
anamileva authored Mar 16, 2021
2 parents 8a8042b + 08a12f3 commit e55eacb
Show file tree
Hide file tree
Showing 189 changed files with 18,799 additions and 5,066 deletions.
4 changes: 2 additions & 2 deletions db/db_schema.sql
Original file line number Diff line number Diff line change
Expand Up @@ -1039,7 +1039,7 @@ subscenarios_project_variable_generator_profiles
DROP TABLE IF EXISTS subscenarios_project_hydro_operational_chars;
CREATE TABLE subscenarios_project_hydro_operational_chars (
project VARCHAR(64),
hydro_operational_chars_scenario_id,
hydro_operational_chars_scenario_id INTEGER,
name VARCHAR(32),
description VARCHAR(128),
PRIMARY KEY (project, hydro_operational_chars_scenario_id)
Expand Down Expand Up @@ -2530,7 +2530,7 @@ load_zone VARCHAR(32),
rps_zone VARCHAR(32),
carbon_cap_zone VARCHAR(32),
technology VARCHAR(32),
power_mw FLOAT, -- net power in case there's auxiliary consumption
power_mw FLOAT, -- grid net power in case there's curtailment and/or aux cons
scheduled_curtailment_mw FLOAT,
subhourly_curtailment_mw FLOAT,
subhourly_energy_delivered_mw FLOAT,
Expand Down
14 changes: 9 additions & 5 deletions doc/source/advanced_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Projects
gridpath.project.__init__
-------------------------
.. automodule:: gridpath.project.__init__
:members: determine_dynamic_components, add_model_components
:members: add_model_components

Project Capacity
----------------
Expand Down Expand Up @@ -181,13 +181,17 @@ gridpath.project.capacity.operational_types.gen_always_on
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gridpath.project.operations.operational_types.gen_always_on.add_model_components

gridpath.project.capacity.operational_types.gen_commit_bin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gridpath.project.operations.operational_types.gen_commit_bin.add_model_components

gridpath.project.capacity.operational_types.gen_commit_lin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gridpath.project.operations.operational_types.gen_commit_lin.add_model_components

gridpath.project.capacity.operational_types.gen_commit_bin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gridpath.project.operations.operational_types.gen_commit_bin.add_model_components
gridpath.project.capacity.operational_types.gen_commit_unit_common
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gridpath.project.operations.operational_types.gen_commit_unit_common.add_model_components

gridpath.project.capacity.operational_types.gen_commit_cap
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -362,7 +366,7 @@ gridpath.project.operations.reserves.reserve_provision
------------------------------------------------------

.. automodule:: gridpath.project.operations.reserves.reserve_provision
:members: generic_determine_dynamic_components
:members: generic_record_dynamic_components



Expand Down
2 changes: 1 addition & 1 deletion doc/source/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ gridpath.run_scenario
.. automodule:: gridpath.run_scenario
:members: main, parse_arguments, ScenarioStructure, run_scenario,
run_optimization, create_and_solve_problem,
populate_dynamic_components, create_abstract_model,
create_abstract_model,
load_scenario_data, create_problem_instance, fix_variables, solve


Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
#html_static_path = ['_static']


# -- Options for HTMLHelp output ------------------------------------------
Expand Down
32 changes: 22 additions & 10 deletions doc/source/database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ This chapter describes the following:
* :ref:`database-testing-section-ref` : instructions on how to validate the
database inputs

.. _database-section-ref:

Database Structure
##################

.. _database-section-ref:

.. automodule:: db


Expand Down Expand Up @@ -246,98 +246,109 @@ Requirement
Regulation Down
***************

===============
Balancing Areas
===============

.. automodule:: db.csvs_test_examples.reserves.regulation_down.geography_regulation_down_bas.doc

=====================
Contributing Projects
=====================

.. automodule:: db.csvs_test_examples.reserves.regulation_down.project_regulation_down_bas.doc

===========
Requirement
===========

.. automodule:: db.csvs_test_examples.reserves.regulation_down.req.doc


=================
Spinning Reserves
=================
*****************

===============
Balancing Areas
===============

.. automodule:: db.csvs_test_examples.reserves.spinning_reserves.geography_spinning_reserves_bas.doc


=====================
Contributing Projects
=====================

.. automodule:: db.csvs_test_examples.reserves.spinning_reserves.project_spinning_reserves_bas.doc


===========
Requirement
===========

.. automodule:: db.csvs_test_examples.reserves.spinning_reserves.req.doc

==========================
Load-Following Reserves Up
==========================
**************************

===============
Balancing Areas
===============

.. automodule:: db.csvs_test_examples.reserves.lf_reserves_up.geography_lf_reserves_up_bas.doc

=====================
Contributing Projects
=====================

.. automodule:: db.csvs_test_examples.reserves.lf_reserves_up.project_lf_reserves_up_bas.doc

===========
Requirement
===========

.. automodule:: db.csvs_test_examples.reserves.lf_reserves_up.req.doc


============================
Load-Following Reserves Down
============================
****************************

===============
Balancing Areas
===============

.. automodule:: db.csvs_test_examples.reserves.lf_reserves_down.geography_lf_reserves_down_bas.doc

=====================
Contributing Projects
=====================

.. automodule:: db.csvs_test_examples.reserves.lf_reserves_down.project_lf_reserves_down_bas.doc

===========
Requirement
===========

.. automodule:: db.csvs_test_examples.reserves.lf_reserves_down.req.doc



===========================
Frequency Response Reserves
===========================
***************************

===============
Balancing Areas
===============

.. automodule:: db.csvs_test_examples.reserves.frequency_response.geography_frequency_response_bas.doc

=====================
Contributing Projects
=====================

.. automodule:: db.csvs_test_examples.reserves.frequency_response.project_frequency_response_bas.doc

===========
Requirement
===========

Expand Down Expand Up @@ -396,6 +407,7 @@ Once you have built the database with a set of scenarios and associated inputs,
you can test the inputs for a given scenario by running the inputs validation
suite. This suite will extract the inputs for the scenario of interest and
check whether the inputs are valid. A few examples of invalid inputs are:

- required inputs are missing
- inputs are the wrong datatype or not in the expected range
- inputs are inconsistent with a related set of inputs
Expand Down
14 changes: 7 additions & 7 deletions doc/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ Git to download the source code.

Installing Git
--------------
Git installation instructions are `here <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_
Git installation instructions are `here <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`__

On Windows, use the Git installer available `here <https://git-scm
.com/download/win>`_.
.com/download/win>`__.

On MacOS, type :code:`git --version` on the command line; if you don't have
Git installed already, you will be prompted to install it.
Expand All @@ -58,7 +58,7 @@ Once you have Git installed, clone the repository with::
the current directory.)

For more info on cloning repositories, see `the instructions on GitHub
<https://help.github.com/en/articles/cloning-a-repository>`_.
<https://help.github.com/en/articles/cloning-a-repository>`__.

We will eventually distribute GridPath through pypi and conda, so cloning the
repository will not be required except for users who want to edit the source
Expand All @@ -73,8 +73,8 @@ Python

Running GridPath requires a Python 3 installation and several Python
packages. You can get the official CPython distribution `here
<https://www.python.org/downloads/>`_, the Anaconda Python distribution
`here <https://www.anaconda.com/distribution/>`_, or `another Python
<https://www.python.org/downloads/>`__, the Anaconda Python distribution
`here <https://www.anaconda.com/distribution/>`__, or `another Python
distribution <https://wiki.python.org/moin/PythonDistributions>`_. GridPath
is written and tested in Python 3.8 and we do not recommend using other Python
versions.
Expand Down Expand Up @@ -213,13 +213,13 @@ is `supported by Pyomo <https://pyomo.readthedocs
e.g. GLPK, CPLEX, Gurobi, etc.

You can find the latest instructions for installing Cbc `here
<https://github.com/coin-or/Cbc#download>`_. On Windows, you can also
<https://github.com/coin-or/Cbc#download>`__. On Windows, you can also
download the Cbc executable from the `AMPL website <https://ampl
.com/products/solvers/open-source/#cbc>`_. GridPath allows you to specify
the location of the solver executable; to get it to be recognized,
automatically, you can also add it to your PATH system variables (see
instructions for Windows `here <https://www.java.com/en/download/help/path
.xml>`_).
.xml>`__).


Testing Your Installation
Expand Down
2 changes: 1 addition & 1 deletion examples/2horizons/inputs/fuels.tab
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FUELS co2_intensity_tons_per_mmbtu
Coal 0.09552000000000001
Coal 0.09552
Gas 0.05306
Uranium 0.0
2 changes: 1 addition & 1 deletion examples/2horizons/inputs/heat_rate_curves.tab
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Coal 0 0.4 1250.0
Coal 0 1.0 506.0
Gas_CCGT 0 0.5 506.0
Gas_CCGT 0 1.0 256.0
Gas_CT 0 0.4 208.33333000000002
Gas_CT 0 0.4 208.33333
Gas_CT 0 1.0 88.13333
Nuclear 0 1.0 1666.67
2 changes: 1 addition & 1 deletion examples/2horizons_w_hydro/inputs/fuels.tab
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FUELS co2_intensity_tons_per_mmbtu
Coal 0.09552000000000001
Coal 0.09552
Gas 0.05306
Uranium 0.0
2 changes: 1 addition & 1 deletion examples/2horizons_w_hydro/inputs/heat_rate_curves.tab
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Coal 0 0.4 1250.0
Coal 0 1.0 506.0
Gas_CCGT 0 0.5 506.0
Gas_CCGT 0 1.0 256.0
Gas_CT 0 0.4 208.33333000000002
Gas_CT 0 0.4 208.33333
Gas_CT 0 1.0 88.13333
Nuclear 0 1.0 1666.67
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FUELS co2_intensity_tons_per_mmbtu
Coal 0.09552000000000001
Coal 0.09552
Gas 0.05306
Uranium 0.0
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Coal 0 0.4 1250.0
Coal 0 1.0 506.0
Gas_CCGT 0 0.5 506.0
Gas_CCGT 0 1.0 256.0
Gas_CT 0 0.4 208.33333000000002
Gas_CT 0 0.4 208.33333
Gas_CT 0 1.0 88.13333
Nuclear 0 1.0 1666.67
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FUELS co2_intensity_tons_per_mmbtu
Coal 0.09552000000000001
Coal 0.09552
Gas 0.05306
Uranium 0.0
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Coal 0 0.4 1250.0
Coal 0 1.0 506.0
Gas_CCGT 0 0.5 506.0
Gas_CCGT 0 1.0 256.0
Gas_CT 0 0.4 208.33333000000002
Gas_CT 0 0.4 208.33333
Gas_CT 0 1.0 88.13333
Nuclear 0 1.0 1666.67
2 changes: 1 addition & 1 deletion examples/2periods/inputs/fuels.tab
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FUELS co2_intensity_tons_per_mmbtu
Coal 0.09552000000000001
Coal 0.09552
Gas 0.05306
Uranium 0.0
2 changes: 1 addition & 1 deletion examples/2periods/inputs/heat_rate_curves.tab
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Coal 0 0.4 1250.0
Coal 0 1.0 506.0
Gas_CCGT 0 0.5 506.0
Gas_CCGT 0 1.0 256.0
Gas_CT 0 0.4 208.33333000000002
Gas_CT 0 0.4 208.33333
Gas_CT 0 1.0 88.13333
Nuclear 0 1.0 1666.67
2 changes: 1 addition & 1 deletion examples/2periods_gen_bin_econ_retirement/inputs/fuels.tab
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FUELS co2_intensity_tons_per_mmbtu
Coal 0.09552000000000001
Coal 0.09552
Gas 0.05306
Uranium 0.0
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Coal 0 0.4 1250.0
Coal 0 1.0 506.0
Gas_CCGT 0 0.5 506.0
Gas_CCGT 0 1.0 256.0
Gas_CT 0 0.4 208.33333000000002
Gas_CT 0 0.4 208.33333
Gas_CT 0 1.0 88.13333
Nuclear 0 1.0 1666.67
2 changes: 1 addition & 1 deletion examples/2periods_gen_lin_econ_retirement/inputs/fuels.tab
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FUELS co2_intensity_tons_per_mmbtu
Coal 0.09552000000000001
Coal 0.09552
Gas 0.05306
Uranium 0.0
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Coal 0 0.4 1250.0
Coal 0 1.0 506.0
Gas_CCGT 0 0.5 506.0
Gas_CCGT 0 1.0 256.0
Gas_CT 0 0.4 208.33333000000002
Gas_CT 0 0.4 208.33333
Gas_CT 0 1.0 88.13333
Nuclear 0 1.0 1666.67
2 changes: 1 addition & 1 deletion examples/2periods_new_build/inputs/fuels.tab
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FUELS co2_intensity_tons_per_mmbtu
Coal 0.09552000000000001
Coal 0.09552
Gas 0.05306
Uranium 0.0
4 changes: 2 additions & 2 deletions examples/2periods_new_build/inputs/heat_rate_curves.tab
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Gas_CCGT 0 0.5 506.0
Gas_CCGT 0 1.0 256.0
Gas_CCGT_new 0 0.5 506.0
Gas_CCGT_new 0 1.0 256.0
Gas_CT 0 0.4 208.33333000000002
Gas_CT 0 0.4 208.33333
Gas_CT 0 1.0 88.13333
Gas_CT_new 0 0.4 208.33333000000002
Gas_CT_new 0 0.4 208.33333
Gas_CT_new 0 1.0 88.13333
Nuclear 0 1.0 1666.67
2 changes: 1 addition & 1 deletion examples/2periods_new_build_2zones/inputs/fuels.tab
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FUELS co2_intensity_tons_per_mmbtu
Coal 0.09552000000000001
Coal 0.09552
Gas 0.05306
Uranium 0.0
Loading

0 comments on commit e55eacb

Please sign in to comment.