updated docs

docs/_static/otoole_figures.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2023-02-14T01:03:00.560Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/20.8.16 Chrome/106.0.5249.199 Electron/21.4.0 Safari/537.36" etag="-DvL3dyiyL_X6zn_Eq4D" version="20.8.16" type="device" pages="2"><diagram name="Title_Figure" id="pjIfZw4v7WyeL_7fHA9d">7Vptd6I4GP01ftlz5JBAePmolnY6206d2nba/RYhIDtgPBhfur9+EwgKhtp2qqvb0Z5TyYUEeO69D08iLaOXLi8yPBld04AkLagHy5Zx1oLQdVz+XwDPBYAcWABRFgcFpK+BQfwPKUBQorM4IFOJFRCjNGHxpA76dDwmPqthOMvoon5YSJOgBkxwRBRg4ONERX/EARsVqIP0Nf6FxNGoPDPQ5Z4UlwdLYDrCAV1UIMNrGb2MUlZspcseSUTs6nE5f2Hv6sIyMmZv6fD4/fI+9Dz7K7o1Hojz3YTppA0MeXHsubxjEvAAyOaYjvlXN6OzcUDEODpv0YyNaETHOLmidMJBwMG/CWPPkj48Y5RDI5Ymci9Zxuyxsv0khtKQbJ0t5ch547lsjFn2/FhtVHqJ5rpb3ir7TVlGf67IMjgS0jGTlwat/AicsY4Qx/oWc+w8ThI5ShEWEYsXwy2hKZ1lPtkWY6l4foaIsC0HmitVcDcRmhJ+W7xfRhLM4nn9QrDUdbQ6bk0935Dsv0MJ0N6qhDXp3hrdnTDWYniq7GkWxpES/AHiZNc+jfmpoS5zJyzNKVOnVebEcojiwmSvqvM3B9I3BrKt+kCFMpWBch2t7ufXpVUaYI6TmQyGorW1kgT5i1HMyGCC87Av+IOlrpqQ09ijCc3yvkaIxJ/UQQUvPivFVPZY+WelgjnJGFlu14FKr+zg2Fy71fCahuRpsX5gwBIbVR8Wjv6yJj5kZmAd0szvyfK7MfOvPit2mATMNyZ54O4lWSBQFyGCG9ras8dXcTp6xX2auuLNinMOWleouf4kjOMQRmUacgBhmEpRcDMg1zeDp8EHiwMRfNn36IoFA23UCi5UagUAGmqFst/OaUAKDX9o/nSucFBXOazHnM9tJ+K4dBmJVQAtTOjCH3GBa+mMz9XbAfVnaR6iRvYqfgGmSlmAiRP6jdT4DhmGCukf5wmAzaoONVR1DlCJsvZFlNVA1DKZLlWmJBn8SU8ynjQHjGb5KsdrzskXbYDwRr5ak2/VrYczX/LkKIkPvoFIRJzAbCLSgUMj99jOidSV8hwdmEi7gUi2ZLtyXOk1+ALh04IfXQPItgxkWrbr6NC1XKuJwFeSaRhCv9GZgTW00I6SJlTMaLpA4dA2GrKmsycOAVBI7N18e/Bu7zh4+a1/L77POncdhVUeBrZBZS12sjyoBlpCOImjMW/6RBibAyKosY+TjtyRxkGQvOTzekm1yWtda6Cl1jB78aLR4EWoI5VIY28z5dPzr4kqy9LrhnOABpHCldtQqdiWtq/MCdTU2b+96XkDXjLqt97g/upkO5VL0zI0e8N3pnFg38HtPzx8gmlh3uqTLOYBE7o5zrkikE/I11cRULPI/pvJYnmZ1edtt6dI6PNMFFGZ67YsKjdlX7Q3w5onwx6FYd3/h2Fd1bD9K+/xd7Ks+7aCaX+WRSfLHoNly59ijtyy5WVWLHsxy+gw/o08i3itfGjXqqXOw+XgvnN1+ZfH4c43jugPvMnnOd5ptWHLtMdaTVklu7YFtcaZTwO/u5j5zDuh96N7sYgvdAd518N23GZtdeVIYW21gpsW67Zl6K/wkCR9Oo1ZTAUFQ8oYTfkBidjRxf7PKA98SWVAQjxLWAN5TCTzLp5OinfmwngpyOrmJ+yUqF4ifHvEmHjjriPuHZ5neKFFMRvNhrMpyXxOHidF8/m1wPM/7760A28gjrz+Cg2Hx/vcQiY0Q+JgH2Bdd22MYYgd1/e5/wPfCFzTdG04tIvR4zTi/yM8TWlGtOk82o0gHKsmBqtsV5RgQEMzG9aCgQM1x3q3IESkVu/3Fb+0r1+SNLx/AQ==</diagram><diagram id="OXR_P8y7DHDudAfNuGvE" name="Workflow_Figure">7Vttc5s4EP41/tKZeJAEAj7mpb3rTDvNnOcm7X3pEFBsWoxcIb/1158EkkEWJk5iY+dyzgejlZBhn2dXuytlgK6nqz9YNJt8pgnJBtBJVgN0M4AQgNATX1KyriS+gyrBmKVJJXJqwSj9TdSdWjpPE1IoWSXilGY8nZnCmOY5ibkhixijS3PYA80SQzCLxsQSjOIos6V3acInlTTwnFr+J0nHE/3LwFE900gPVoJiEiV02RCh9wN0zSjl1dV0dU0yqTxTLx929G4ejJGc73UDoMH361/j5c3Hf7Ib6P49Se4u1CyLKJurF1YPy9daA4zO84TIScAAXS0nKSejWRTL3qXAXMgmfJqp7oIz+nOjKSl5oDlXsEIs22mWXdOMsnJ29ODJPzWuIa8+mxkbPbj8iB716IRxstqpE7DRtKAooVPC2VoM0TcgxUbFTuThqr2sscYgqGSTBs7QUcJI8Wu8mbuGQFwoFNoRiS+v3MUi/h0svl8mE0oL9P3HRWgBQBLBSNXMaS6+rmpMHNGijE/omOZR9onSmdL7D8L5Wik+mnNq4kRWKf8qbx96qvVNTSavb1bNxlo1OrEFuBwRMX4prU5I4iwqijTW4g9ptvnxPNGD1PsIiep3NsDK1+6GVWiJzlmsR7XxG7bDz0gW8XRhzt8Gpbr1lqbilze0gU449Ezi+O7QaXy2pqyeU83StNHtibXb09MiaE4kNDkm3JqoZNrm/Z5PPoA62VcT7X0tPRwZQZOKQ+h1slFQga0bFJbNb82++ray9UwWK4I2KXwMiopVrUS2C5sdruxpXBbvFa0bA2aSSkUH1f0tDxniTgYjGHaNFxfVEzyXtl0qbKxiNxGPhEQgRixGi4V4Ji8TGs+nJVyPrWr3FcM/3WuBSfluSrlyRHUtSC18hxs4GAe+hz3oH2odw3jLHYXWOhb49jKmbzv4Kibe+mwcif88RwJemyNBfTmSfZnR9ZQNW9VJw1s1VvETJzZWC5J3w7hY2FgYqoNbkb8Caroay0xw+JDRZTwRZB9O5yJdu3gEwG0QttKExCNB4ralAwG8R2U6UM6gHhYcACYIoAETCFp8KmiByTsSTPYq9264yorVTpsRCzNhwn+OOGVlmvuY6ZRpO5BesEzXyysz/YtYrFAKLFuCZwkjAPi8YLQd4LshX/FDWZu2M7gD7o13A56PkediPwwcGOIQt8FngPEcOI/gLyEOLAR1vNNE0DtWiq4Z1VokOWjosm/kYiRAdRhzhpFLR0SyT+ji9RS6dD5mw3TvmLCwgay84UwubffM4AX+NZflvVK/F5XlXYoBwJ2tSg3qfnE1lt+fbnfFQWxCp/fz4nEf/tRo5xArpY5WdECjywhNF+vZBhocy8WCfotop7dZd0+bbVTe6vJcXXwDBzZrb1+zDk5q1p5l1rvt8D+Yj7iOWeJxIdTVzVNlJBuK/W/AJzXgYE8DbmxoncKAA8uARzRbvK5F1NO3nMsiqvctTa3OeUrzN+QcMdqKbWALLL26xrYywLlVayISPMRteSGOA3L/cIQ03w3Mag12fAunsMV8fPdYOLkWTl9G5POX0beRkN5R9lPq3EJNaIAPWrbUtQ7VutBUuBJFWTrO5bpAZNlHCKQ+0zjKLlXHNE2SbFcVyLS77jrAy9FCvokWwnYJFGBkw4WcY8FlB4Ef89lc7mxVe0lnj5N/jOKZZrEunrm29+sZJ2zh9BcphM9620B5rnkewXfgqYEKLCiOepDlWSH8MAzNwwNDF4SPBPJl65awVOhJ0uLVRvdQrZCPR/ewnXv9RPew32LOU05ENbeOQ98kUoiCHojU9yGrFxLppGmifszG0nHLaEyKQgjr1KavnPFlMbNOzl6U27iBsWh4oX36sdeUE9kpp43HwY6jVgvxk1E4gOLdYGtHC9n1NrdlRwscTfG9ngNuVXwvW4nbigehnSX2q3g7m6fyfLvcUzLzD0f5qjQfv5IY9yBhrXketm3zXjCkx7AW2dv3G8C2EpE3itiWa4O4ZTPhUJiJZv0PFNVp0vrfUND7fwE=</diagram></mxfile>

docs/conf.py

@@ -172,6 +172,11 @@
     "path_to_docs": "docs",
     "use_repository_button": True,
     "use_edit_page_button": True,
+    "extra_navbar":
+        """
+        <p>Theme by the <a href="https://executablebooks.org/en/latest/">Executable Book Project</a></p>
+        <p>Logo by <a href="https://looka.com/">looka.com</a></p>
+        """,
 }
 
 # Add any paths that contain custom themes here, relative to this directory.

docs/examples.rst

@@ -138,24 +138,16 @@ Use ``otoole`` to validate the input data.
 
 Step One: Create the Validation File
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
+To be done
 
 Step Two: ``otoole`` Validate
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The validation functionality of ``otoole`` will work with any supported
-input data format (``csv``, ``datafile``, or ``excel``). In this case, we will
-use the folder of csv data for validation.
-
-Run the following command, where the RES will be saved as the file ``res.png``::
-
-    $ otoole viz res excel simplicity.xlsx res.png config.yaml
+To be done
 
-Step Two: View the RES
-~~~~~~~~~~~~~~~~~~~~~~
-Open the newly created file, ``res.png`` and the following image should be
-displayed
+Step Three: Validation Results
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+To be done
 
-.. image:: _static/simplicity_res.png
 
 .. _Simplicity: https://github.com/OSeMOSYS/simplicity
 .. _GLPK: https://www.gnu.org/software/glpk/

docs/functionality.rst

@@ -16,7 +16,7 @@ pre-processing. Anything that happens with the immediate outputs of a solver, su
 the recommended open-source solvers GLPK_, CBC_, or the proprietary solvers CPLEX_ and
 Gurobi_, is called results and post-processing.
 
-.. image:: _static/osemosys_dataflow.png
+.. image:: _static/workflow.png
 
 Configuration File
 ------------------

docs/index.rst

@@ -10,7 +10,7 @@ to provide commonly used pre- and post-processing steps when  working with OSeMO
 Specifically, ``otoole`` allows the user to convert between data formats, process solutions,
 and visualise the reference energy system.
 
-.. image:: _static/overview.png
+.. image:: _static/overview_v2.png
 
 Currently, ``otoole`` only supports the GNU MathProg version of OSeMOSYS. We hope to build
 support for other implementations of OSeMOSYS soon. In fact, this is one of the key aims