Skip to content

Commit

Permalink
Updated readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
ricnogfer committed Jun 8, 2023
1 parent b736f2b commit 901c3a8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ To color a certain component (namely: bus, generator, load, store or line) in fu

In case fine-grained selection/visiting logic is needed, parameters `bus_filter`, `generator_filter`, `load_filter`, `store_filter`, `link_filter` and `line_filter` (in function `generate`) may be utilized in combination or separately. These parameters are expected to be (user-defined) [regular expressions](https://en.wikipedia.org/wiki/Regular_expression). While parameters `bus_filter`, `generator_filter`, `load_filter` and `store_filter` tell PyPSATopo which buses, generators, loads and stores to include/exclude, parameters `link_filter` and `line_filter` tell which links and lines may be visited (or not) upon generating the topographical representation of a network.

By default, excluded components are not shown in the topographical representation of a network. In certain situations, however, it might be useful to understand where selected (included) components are located in the representation among excluded components. To show selected components in the topographical representation of a network among excluded components, set parameter `context = True` when calling function `generate`. While selected components are shown with the appropriate colors, excluded components are shown with faded colors (to distingish these from the formers).
By default, excluded components are not shown in the topographical representation of a network. In certain situations, however, it might be useful to understand where selected (included) components are located in the representation among excluded components. To show selected components in the topographical representation of a network among excluded components, set parameter `context = True` when calling function `generate`. While selected components are shown with the appropriate colors, excluded components are shown with faded colors (to distinguish these from the formers visually speaking).

Given that it may take some time to process a complex network, PyPSATopo is capable of displaying log messages while processing such network. Log messages not only describe the stage at which the tool is in the processing pipeline but also potential issues that the network may have. To enable PyPSATopo displaying log messages, set parameter `quiet = False` (when calling function `generate`). Otherwise, in case the parameter is not set, the tool behaves quietly by default (i.e. no log messages are displayed).

Expand Down

0 comments on commit 901c3a8

Please sign in to comment.