The Hetero-Functional Graph Theory (HFGT) is a rigorous modeling platform that can model the structure and function of highly interconnected and heterogeneous engineering systems seen in systems-of-systems. A detailed explaination of the theory and the underlying mathematics can be found in the book A Hetero-functional Graph Theory for Modeling Interdependent Smart City Infrastructure. This toolbox facilitates the instantiation of the seven mathematical models of the HFGT from a single XML input file.
A paper that serves as a user guide on how to use this toolbox has currently been submitted to Scientific Reports and is currently under review. If and when accepted, it shall be uploaded to this repository for further clarity.
The toolbox contains two principal modules: XML2LFES() and raw2FullLFES() that are executed in sequence. In brief, the XML2LFES() module serves to import the input XML file and create the myLFES data structure in a “raw" structure. Then, the raw2Full() module makes the HFGT calculations necessary to convert the myLFES data structure to the “full" state.
The input XML file - "Example_Network.xml" provided in this repository depicts a simplistic 4-Node Smart City Network. The topology of this example network and some of the associated graphs of the HFGT mathematical models are presented below. An input XML file for any engineering system can be generated along the same lines and the engineering system's HFGT models can be computed using this toolbox.
This recently developed Hetero-functional Graph Theory Toolbox facilitates the computation of HFGT mathematical models including the hetero-functional adjacency matrix, hetero-functional incidence tensors and the associated knowledge basis. It is written in the programming language python version 3.9 and when handling large computation is ported to the language Julia. It is openly available on GitHub with sample input files for straightforward re-use.
To install this package into an existing virtual environment with python 3.9 follow the steps below inside your Terminal or Command Window. We Recommend using Anaconda to provide a virtual environment to set up the toolbox in.
- run:
cd <System path to Toolbox>/HFGTToolbox-master/Python-HFGT-Toolbox pip install poetry poetry add pyproject.toml poetry install - Install Julia into existing environment's path:
- Install Julia into your current working environment (https://julialang.org/downloads/).
- Once Julia is installed, install the following packages to your Julia using the following commands from the Julia shell:
using Pkg Pkg.add("CSV") Pkg.add("DataFrames") - To test that everything is set up correctly try running the following two lines:
python src/python_hfgt_toolbox/PyHFGTToolbox_Analysis.py "data/XMLs/Example_Network.xml" 0
python src/python_hfgt_toolbox/PyHFGTToolbox_Analysis.py "data/XMLs/Example_Network_DOFs_Idx.xml" 3
- To run the toolbox in your terminal window and retain access to the overarching LFES object that contains the HFG in a python environment within the terminal run the line:
python -i src/python_hfgt_toolbox/PyHFGTToolbox_Analysis.py "data/XMLs/Example_Network.xml" 0
The HFGT toolbox repository contains the following directories:
-
XML2LFES: The XML2LFES repository has the following subfolders:
a) XML2LFES_classes: Sets up the LFES class structure
b) XML2LFES_functions: Functions that help read the XML file and convert it to the LFES class structure.
2)raw2FullLFES: The raw2Full repository has the following subfolders:
a) raw2FullLFES_functions:
Functions that perform the HFGT analysis.
The PyHFGTToolbox_Analysis.inpyb file shows how to use the toolbox. Additionally, the toolbox repository contains four sample input XML files:
I) Example_Network.xml - The example network from Chapter 4 of the HFGT book.
II) Example_Network_DOFs_Idx.xml - The example network from Chapter 4 of the HFGT book in the DOF index based format for running the Julia verboseMode (3).
III) AMES_NY_Elec_NG_Oil_Coal.xml - The AMES HFGT compliant XML of the American Multimodal Energy System's region of NY.
IV) AMES_NY_Elec_NG_Oil_Coal.xml - The AMES HFGT compliant XML of the American Multimodal Energy System's region of NY in the DOF index based format to running the Julia verboseMode(3).
NOTE : The assignment of values to parameters in the LFES class structure happens within the functions in XML2LFES and raw2FullLFES.
Also NOTE : This version of the toolbox is a work in progress.
The service feasibility matrices might still be incorrect as in the book. Need to upgrade to V-10 trimetrica to test and might need to change the usage of the map function in the service matrices to regex.