example page added

docs/api/osemosys_global.emissions.rst

@@ -0,0 +1,71 @@
+osemosys\_global.emissions namespace
+====================================
+
+.. py:module:: osemosys_global.emissions
+
+Submodules
+----------
+
+osemosys\_global.emissions.constants module
+-------------------------------------------
+
+.. automodule:: osemosys_global.emissions.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.emissions.data module
+--------------------------------------
+
+.. automodule:: osemosys_global.emissions.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.emissions.emission\_activity\_ratio module
+-----------------------------------------------------------
+
+.. automodule:: osemosys_global.emissions.emission_activity_ratio
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.emissions.emission\_limit module
+-------------------------------------------------
+
+.. automodule:: osemosys_global.emissions.emission_limit
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.emissions.emission\_penalty module
+---------------------------------------------------
+
+.. automodule:: osemosys_global.emissions.emission_penalty
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.emissions.main module
+--------------------------------------
+
+.. automodule:: osemosys_global.emissions.main
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.emissions.read module
+--------------------------------------
+
+.. automodule:: osemosys_global.emissions.read
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.emissions.sets module
+--------------------------------------
+
+.. automodule:: osemosys_global.emissions.sets
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/osemosys_global.powerplant.rst

@@ -0,0 +1,159 @@
+osemosys\_global.powerplant namespace
+=====================================
+
+.. py:module:: osemosys_global.powerplant
+
+Submodules
+----------
+
+osemosys\_global.powerplant.GEM\_unused module
+----------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.GEM_unused
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.activity module
+-------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.activity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.availability module
+-----------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.availability
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.backstop module
+-------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.backstop
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.calibration module
+----------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.calibration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.constants module
+--------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.costs module
+----------------------------------------
+
+.. automodule:: osemosys_global.powerplant.costs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.data module
+---------------------------------------
+
+.. automodule:: osemosys_global.powerplant.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.fuel\_limits module
+-----------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.fuel_limits
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.investment\_constraints module
+----------------------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.investment_constraints
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.main module
+---------------------------------------
+
+.. automodule:: osemosys_global.powerplant.main
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.operational\_life module
+----------------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.operational_life
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.read module
+---------------------------------------
+
+.. automodule:: osemosys_global.powerplant.read
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.renewable\_targets module
+-----------------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.renewable_targets
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.residual\_capacity module
+-----------------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.residual_capacity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.sets module
+---------------------------------------
+
+.. automodule:: osemosys_global.powerplant.sets
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.user\_defined\_capacity module
+----------------------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.user_defined_capacity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.utils module
+----------------------------------------
+
+.. automodule:: osemosys_global.powerplant.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.powerplant.variable\_costs module
+--------------------------------------------------
+
+.. automodule:: osemosys_global.powerplant.variable_costs
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/osemosys_global.reserves.rst

@@ -0,0 +1,55 @@
+osemosys\_global.reserves namespace
+===================================
+
+.. py:module:: osemosys_global.reserves
+
+Submodules
+----------
+
+osemosys\_global.reserves.data module
+-------------------------------------
+
+.. automodule:: osemosys_global.reserves.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.reserves.main module
+-------------------------------------
+
+.. automodule:: osemosys_global.reserves.main
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.reserves.read module
+-------------------------------------
+
+.. automodule:: osemosys_global.reserves.read
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.reserves.reserve\_margin module
+------------------------------------------------
+
+.. automodule:: osemosys_global.reserves.reserve_margin
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.reserves.reserve\_margin\_tag\_fuel module
+-----------------------------------------------------------
+
+.. automodule:: osemosys_global.reserves.reserve_margin_tag_fuel
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+osemosys\_global.reserves.reserve\_margin\_tag\_technology module
+-----------------------------------------------------------------
+
+.. automodule:: osemosys_global.reserves.reserve_margin_tag_technology
+   :members:
+   :undoc-members:
+   :show-inheritance: