First commit

.gitignore

@@ -0,0 +1,2 @@
+
+docs/build/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Veda 2.0'
+copyright = '2020, KanORS-EMR'
+author = 'KanORS-EMR'
+
+# The full version, including alpha/beta/rc tags
+release = '196.1.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'alabaster'
+
+# 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']

docs/source/index.rst

@@ -0,0 +1,30 @@
+.. Veda 2.0 documentation master file, created by
+   sphinx-quickstart on Fri Dec 11 14:14:26 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Veda 2.0's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   pages/introduction
+   pages/Getting started
+   pages/Start page
+   pages/Veda Menu
+   pages/Navigator
+   pages/Browse
+   pages/Items List
+   pages/Items detail
+   pages/TIMES attributes
+   pages/Run Manager
+   pages/Results
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/pages/Browse.rst

@@ -0,0 +1,12 @@
+=======================
+Browse
+=======================
+
+* Browse both presents the actual model data and provides direct access to the input data  (`youtube video <https://youtu.be/sRMCd2wVqGY>`_).
+* Clicking any input cell in the data cube (red circle) provides direct access to specific cells in the excel templates for editing.
+
+.. image:: images/Browse.png
+   :width: 600
+
+The Browser thereby enables the user to view subsets of the assembled data in a cube by selecting the scenario(s), region(s), process(es), commodity(ies), and/or the attribute(s) of interest.
+It is possible to rearrange the layout of the cube by adding/removing dimensions (columns and rows) to/from the table.

docs/source/pages/Getting started.rst

@@ -0,0 +1,52 @@
+================
+Getting started
+================
+
+Installation
+#############
+
+`Veda download link <https://showcase.dropbox.com/s/Veda2.0-5bA9awGzRHGWc5BWXuU3N>`_
+
+* To download and install VEDA2.0 it is recommend that the new user first takes a look at the `YouTube video <https://youtu.be/QQzZi2_vWBs>`_.
+    * There are two ways to go about it:
+        * Localhost: This just needs to be unzipped.
+        * Installer: This is a setup executable.
+
+
+Licensing
+#########
+
+`Demo video <https://youtu.be/6FFAw-rXD8A>`_
+
+Once setup, to start using VEDA2.0, the user is required to get licence. Launching Veda will present an Activation screen:
+
+.. image:: images/license_form.png
+    :width: 600
+
+One can proceed by:
+    *	Hitting 'Get Trail Key'
+    *	Completing the Registration Form
+    *	Grabbing the Trail Key from your email,
+    *	Paste it into the Activation form, and request Activation
+
+
+This will then bring you to the VEDA2.0 Start Page, if activated successfully.
+
+
+Setting up GAMS
+################
+
+As part of registering VEDA2.0 a request is sent to the ETSAP Liaison Officer who will arrange for an evaluation GAMS license file to be created, sending it to the new user along with the download and install procedures here:
+
+1.	Copy the GAMSLICE someplace on your computer.
+2.	Head to http://www.gams.com/download/ and select the Windows download option for either Win-64/32, as appropriate
+3.	Run Setup by clicking on it in Windows Explorer
+
+    a)	Check “Use advanced installation mode” at the bottom of the GAMS Setup form.
+    b)	Let GAMS get installed into the default folder (\GAMS\<Win#>\<ver>.
+    c)	Check the Add GAMS directory to PATH environment variable.
+    d)	Have the GAMSLICE.TXT copied from wherever it currently resides.
+
+You may need to restart your computer to have the GAMS Path activated.
+
+Once you have VEDA installed you can try a TIMES model run.

docs/source/pages/Items List.rst

@@ -0,0 +1,8 @@
+==============
+Items List
+==============
+
+The Items List provides a look at all the data assembled from Templates Into the VEDA2.0 database by component type: Process, Commodity, Commodity Group, User Constraint.
+
+.. image:: images/items_list.png
+    :width: 600

docs/source/pages/Items detail.rst

@@ -0,0 +1,7 @@
+============
+Items detail
+============
+
+You can examine the declaration, connectivity and data details for a Process
+
+.. image:: images/items_detail.png

docs/source/pages/Navigator.rst

@@ -0,0 +1,72 @@
+=======================
+Navigator
+=======================
+
+* The Navigator provides a comprehensive view of all the templates in the various folders managed by VEDA-FE for the current model (youtube video).
+* The Navigator is the main vehicle for accessing, importing, and coordinating the various templates that make up a model.
+* Its main screen is divided into sub-windows according to the various types of templates managed by VEDA-FE.
+
+.. image:: images/navigator.png
+   :width: 600
+
+
+Quadrants
+###################################
+
+Template containing comprehensive information about the model’s basic structure (regions, sub-regions, time-periods, time-slices, …)
+**SysSetting**
+
+Calibration templates for Base Year
+**Base scenario** [BS] – current technology mix
+**BaseTrans** – operations on the BS templates
+
+Repository for the depiction of future technologies
+**SubRES** [SR]
+
+Three groups of flexible, “rule-based”, scenarios files:
+**Regular Scenarios** [RS] - files for data addition and updates
+**Demand Scenarios** [DS] - projection module tied to economic indicators, fine-tuned with analyst insight
+**Parametric Scenarios** [PS] - functionality designed to handle easily multiple runs and parametric analysis
+
+
+Two new components are presented:
+
+* Parametric scenarios – “programmed” multi-value suite of scenarios
+* No Seed Values – the files that are not dependant on any other template
+
+Functionality
+###############
+
+* Navigator enables easy access to any of the Excel templates constituting the currently open model
+* Double-clicking directly on any file name (or click the Excel icon next to it, in the case of the BY_Trans and SysSettings files) will open that file in Excel
+* Clicking on the folder button above each section of the Navigator will open the associated folder in Windows Explorer
+* Provides feedback as to the status of the various files and the integrated database managed by VEDA-FE according to colour legend at the bottom of form
+    * Not imported – not yet brought into VEDA-FE
+    * Imported – selected for importing with next SYNC
+    * Consistent – template and database aligned
+    * InConsistent – template date stamp more recent that last import
+    * ToRemove – missing template imported previously now flagged for removal from the database
+    * FileMissing – previously imported template no longer found
+    * FileOpen – a template currently open, so can not be processed/imported
+    * Error – if a file error happens
+
+.. image:: images/nav_files_status_legend.png
+   :width: 600
+
+* The SYNCHRONIZE button will process all templates in the application folder marked as ToImport (orange)
+
+
+
+
+SYNC Operation
+###################################
+
+Synchronize imports all selected Excel workbooks into the VEDA-FE database
+
+.. image:: images/sync_form_2.png
+   :width: 600
+
+Right form traces the SYNC operation and the left reports the time needed for each step
+
+After synchronizing a model you can return to the Navigator.
+