Merge pull request #316 from cacodcar/read

Read

Author: cacodcar

README.md

@@ -26,9 +26,9 @@ Notably, impact is ascertained as a function of decisions. The trade-offs betwee
 <!-- ![alt text](https://github.com/TAMUparametric/energiapy/blob/main/docs/hierarchy.png?raw=true) -->
 
 
-# Features 
+# Modeled Aspects:
 
-Available constraints are able to model:
+This is an indicative list of the types of decisions and phenomena that Energia models:
 
 1. network design (with discrete choice)
 2. resource flows
@@ -40,39 +40,71 @@ Available constraints are able to model:
 8. transportation
 9. failure and loss
 
-Examples of objectives towards which the model can be optimized include:
+# Objective Criteria
+
+Generally, any commodity or impact stream or decision can be optimized. 
+Some examples are listed: 
 
 1. minimizing cost
 2. minimizing impact
 3. maximizing resource discharge
 
+
+# Managing Complexity
+
 Clustering submodules include:
 
 1. agglomerative hierarchial clustering (AHC)
 2. dynamic time warping (DTW)
 3. k-means
 
-Both the input data and solution output can be illustrated, examples include:
 
-1. input data: capacity, demand, cost factors
+Other approaches to managing computational complexity include:
+
+1. Integer cuts 
+2. Piece-wise linearization (PWL) for non-linear models 
+
+
+# Printing 
+
+Printing functions all use latex strings, and the following can be displayed:
+
+1. The mathematical program in set notation, and also descriptively at each index
+2. The solution, which can also be compared across multiple objectives
+
+# Visualization 
+
+The following can be visualized using line and bar plots:
+
+1. input data scenario, e.g. capacity limitations, demand, cost factors
 2. solution output: inventory, production, consumption, discharge/sales schedule; contribution towards costs (capital,
    variable and fixed operational), meeting demand.
 
+
+# Library 
+
+energia.library has a variety of pre-loaded sets of:
+
+1. Components such as SI and miscellaneous units, currencies, time units, environmental indicators. 
+2. Example and test problems across various applicative domains
+3. Recipes for decision-making, instructions for calculations, and attribute aliases. 
+
+
+# External Packages
+
 Callable external packages are available for:
 
 1. Integration with high-fidelity process modeling modules such as  
 2. Filling missing data (weekends, public holidays) for time-series data such as resource price
 3. Fetch weather data at an appropriate resolution from [NREL NSRDB](https://nsrdb.nrel.gov/) for any county
    in the US
 
-Libraries have pre-loaded sets of:
-
-1. Components such as SI and miscellaneous units, currencies, time units, environmental indicators. 
-2. Example and test problems across various applicative domains
-3. Recipes for decision-making, instructions for calculations, and attribute aliases. 
 
+# Interface 
 
-Note that some of these functionalities are available in [Energia<2.0.0](https://github.com/TAMUparametric/energiapy/tree/v1.0.7) and are being ported to the 2.0 interface. 
+Energia is optimized for use in jupyter notebooks. Note that some of these functionalities 
+are available in [Energia<2.0.0](https://github.com/TAMUparametric/energiapy/tree/v1.0.7) 
+and are being ported to the 2.0 interface. 
 
 
 

background.rst

@@ -2,9 +2,9 @@ Background and Theory
 =====================
 
 For an overview on the state-of-the-art in energy systems modeling and optimization 
-including key challenges and opportunities see :cite:`kakodkar2022review`. 
+including key challenges and opportunities see :footcite:`kakodkar2022review`. 
 To understand the mathematical programming implementation, the resource task network (RTN)
-methodology :cite:`barbosa_povoa_pantelides_1997` is a great starting point. 
+methodology :footcite:`barbosa_povoa_pantelides_1997` is a great starting point. 
 Energia's :ref:`publication_history` is indicative of key capabilities and applicative 
 domains. For more research on advancing computational methods in modeling and optimization
 see `Multiparameteric Optimization and Control (Pistikopoulos) Group <https://parametric.tamu.edu>`_. 

docs/_autosummary/energia.components.commodities.resource.rst

@@ -1,4 +1,4 @@
-energia.components.commodities.resource
+energia.components.commodities.resource
 =======================================
 
 .. automodule:: energia.components.commodities.resource
@@ -9,6 +9,5 @@ energia.components.commodities.resource
    .. autosummary::
 
       Commodity
-      Environ
       Resource
 

docs/conf.py

@@ -218,5 +218,5 @@
 
 
 # -----# Bibtex configuration-------------------------------------------------------
-bibtex_bibfiles = ["refs.bib", "frameworks.bib"]
+bibtex_bibfiles = ["refs.bib"]
 bibtex_default_style = "unsrt"

docs/frameworks.bib

@@ -9,7 +9,7 @@ Decision-making with Energia
 
 .. toctree::
    :maxdepth: 2
-   :caption: Tutorials
+   :caption: Tutorials & Guide
    :hidden:
 
    tutorials/getting_started/index
@@ -22,7 +22,7 @@ Decision-making with Energia
 
 .. toctree::
    :maxdepth: 1
-   :caption: Examples
+   :caption: Interactive Examples
    :hidden:
 
    examples/scheduling
@@ -38,14 +38,17 @@ Decision-making with Energia
    :caption: Stay Up To Date
    :hidden:
 
-   frameworks
+   publication_history
    changelog
    license
 
 
 Dive into Energia
 ==================
 
+The API
+-------
+
 Refer to the API documentation for a detailed description of the classes and methods available in Energia.
 
 .. autosummary:: 
@@ -57,14 +60,14 @@ Refer to the API documentation for a detailed description of the classes and met
    energia
 
 
-References
-===========
+Easy Navigation
+---------------
 
-.. bibliography::
+The search feature and indexes can be engaged to facilitate navigation:
 
-Indices and tables
-==================
 
+* :ref:`search`
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+
+.. footbibliography::

docs/frameworks.rst

@@ -0,0 +1,21 @@
+.. _publication_history:
+
+
+Publication History
+===================
+
+The applications of Energia have been reported for the following concerns:
+
+- Multiperiod Multiscale Design and Scheduling :cite:`kakodkar2023hydrogen, kakodkar2024multiperiod`
+- Modeling the Material-Energy-Mobility Nexus :cite:`montano2025modeling, flores2025integrating`
+- Carbon Accounting and Life Cycle Assessment Under Uncertainty :cite:`sousa2025integrating, de2025integrated`
+- Robust Scheduling Using Multiparametric Programming :cite:`kakodkar2024robust`
+- Resilience Analysis of Distributed Energy and Manufacturing Systems :cite:`vedant2024information`
+- Modeling of Reverse Supply Chain Networks :cite:`iakovou2024next`
+
+
+References
+----------
+
+.. bibliography::
+    :filter: cited