Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Nov 28, 2024
0 parents commit a63f2c1
Show file tree
Hide file tree
Showing 49 changed files with 4,857 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 8b737c69d6c159c66d3d2efa6f85eae2
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 4 additions & 0 deletions .buildinfo.bak
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 913a02a35704f13e649b87b94d4404b9
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added .nojekyll
Empty file.
45 changes: 45 additions & 0 deletions _sources/first_model_baseline.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
First Model Baseline
=================================

Sets
----

.. csv-table::
:file: /tables/sets_docs.csv
:header-rows: 1
.. automodule:: optimization.pyomo_models.sets
:no-index:

Variables
----------

.. automodule:: optimization.pyomo_models.variables
:no-index:
.. csv-table::
:file: /tables/variables_docs.csv
:header-rows: 1

Parameters
----------

.. automodule:: optimization.pyomo_models.parameters
:no-index:
.. csv-table::
:file: /tables/parameters_docs.csv
:header-rows: 1

Objective
----------

.. automodule:: optimization.pyomo_models.objective
:no-index:

Constraints
------------


.. automodule:: optimization.pyomo_models.constraints.basin_volume
:no-index:

.. automodule:: optimization.pyomo_models.constraints.turbine
:no-index:
18 changes: 18 additions & 0 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. SmallFlex documentation master file, created by
sphinx-quickstart on Tue Nov 26 16:20:09 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SmallFlex documentation
=======================

User Manual
***************

This section outlines the steps a user can follow to generate a new database with updated data.

.. toctree::
:maxdepth: 2

first_model_baseline

Loading

0 comments on commit a63f2c1

Please sign in to comment.