diff --git a/.cspell.json b/.cspell.json new file mode 100644 index 000000000..0b72fe661 --- /dev/null +++ b/.cspell.json @@ -0,0 +1,37 @@ +// cSpell Settings +{ + // Version of the setting file. Always 0.2 + "version": "0.2", + // language - current active spelling language + "language": "en", + // words - list of words to be always considered correct + "words": [ + "autoload", + "buildingspy", + "Combi", + "cvrmsd", + "dassl", + "dymola", + "GDHC", + "levelname", + "libfortran", + "linecount", + "mfrt", + "MODELICAPATH", + "mofile", + "openstudio", + "oversizing", + "redeclarations", + "Reparse", + "setpoint", + "timeseries", + "timestep", + "urbanopt" + ], + // flagWords - list of words to be always considered incorrect + // This is useful for offensive words and common spelling errors. + // For example "hte" should be "the" + "flagWords": [ + "hte" + ] +} diff --git a/.cspell/custom-dictionary-workspace.txt b/.cspell/custom-dictionary-workspace.txt deleted file mode 100644 index fe25b17e4..000000000 --- a/.cspell/custom-dictionary-workspace.txt +++ /dev/null @@ -1,21 +0,0 @@ -# Custom Dictionary Words -autoload -buildingspy -Combi -cvrmsd -dassl -dymola -levelname -libfortran -linecount -mfrt -MODELICAPATH -mofile -openstudio -oversizing -redeclarations -Reparse -setpoint -timeseries -timestep -urbanopt diff --git a/README.rst b/README.rst index 7db8e5f16..4a1b6ff94 100644 --- a/README.rst +++ b/README.rst @@ -22,7 +22,7 @@ The project is motivated by the need to easily evaluate district energy systems. Getting Started --------------- -It is possible to test the GeoJSON to Modelica Translator (GMT) by simpling installing the Python package and running the +It is possible to test the GeoJSON to Modelica Translator (GMT) by simply installing the Python package and running the command line interface (CLI) with results from and URBANopt SDK set of results. However, to fully leverage the functionality of this package (e.g., running simulations), then you must also install the Modelica Buildings library (MBL) and Docker. Instructions for installing and configuring the MBL and Docker are available @@ -55,7 +55,7 @@ More example projects are available in an accompanying Architecture Overview --------------------- -The GMT is designed to enable "easy" swapping of building loads, district systems, and newtork topologies. Some +The GMT is designed to enable "easy" swapping of building loads, district systems, and network topologies. Some of these functionalities are more developed than others, for instance swapping building loads between Spawn and RC models (using TEASER) is fleshed out; however, swapping between a first and fifth generation heating system has yet to be fully implemented.