uesgraphs.examples.e1_readme_example

Creating and Visualizing a Simple Heating Network from the readme.md with uesgraphs

Functions

example_readme()	The example given in the README.md file
main()
workspace_example([name_workspace])	Creates a local workspace with given name

uesgraphs.examples.e1_readme_example.main()

uesgraphs.examples.e1_readme_example.example_readme()

The example given in the README.md file

uesgraphs.examples.e1_readme_example.workspace_example(name_workspace=None)

Creates a local workspace with given name

If no name is given, the general workspace directory will be used

Parameters:

name_workspace (str) – Name of the local workspace to be created

Returns:

workspace – Full path to the new workspace

Return type:

str