New feature: self documenting models

fwitte commented 3 years ago

This PR introduces self documenting TESPy models. The goal is facilitating documentation of your TESPy models and to improve transparency of the documentation of such models. The feature will be shipped with the upcoming release but will still be in development.

pep8speaks commented 3 years ago

Hello @fwitte! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

In the file src/tespy/components/basics/cycle_closer.py:

Line 27:80: E501 line too long (88 > 79 characters) Line 28:80: E501 line too long (88 > 79 characters)

In the file src/tespy/components/combustion/combustion_chamber.py:

Line 35:80: E501 line too long (96 > 79 characters) Line 36:80: E501 line too long (106 > 79 characters) Line 37:80: E501 line too long (95 > 79 characters) Line 38:80: E501 line too long (101 > 79 characters) Line 42:80: E501 line too long (93 > 79 characters) Line 43:80: E501 line too long (89 > 79 characters)

In the file src/tespy/components/combustion/combustion_chamber_stoich.py:

Line 37:80: E501 line too long (96 > 79 characters) Line 38:80: E501 line too long (106 > 79 characters) Line 39:80: E501 line too long (108 > 79 characters) Line 40:80: E501 line too long (114 > 79 characters) Line 44:80: E501 line too long (106 > 79 characters) Line 45:80: E501 line too long (102 > 79 characters)

In the file src/tespy/components/combustion/combustion_engine.py:

Line 41:80: E501 line too long (90 > 79 characters) Line 43:80: E501 line too long (94 > 79 characters) Line 44:80: E501 line too long (106 > 79 characters) Line 45:80: E501 line too long (95 > 79 characters) Line 46:80: E501 line too long (99 > 79 characters) Line 47:80: E501 line too long (93 > 79 characters) Line 48:80: E501 line too long (92 > 79 characters) Line 49:80: E501 line too long (92 > 79 characters) Line 50:80: E501 line too long (95 > 79 characters) Line 54:80: E501 line too long (93 > 79 characters) Line 55:80: E501 line too long (89 > 79 characters) Line 56:80: E501 line too long (87 > 79 characters) Line 57:80: E501 line too long (87 > 79 characters)

In the file src/tespy/components/component.py:

Line 27:80: E501 line too long (81 > 79 characters)

In the file src/tespy/components/customs/orc_evaporator.py:

Line 39:80: E501 line too long (90 > 79 characters) Line 49:80: E501 line too long (95 > 79 characters)

In the file src/tespy/components/heat_exchangers/condenser.py:

Line 21:80: E501 line too long (81 > 79 characters) Line 40:80: E501 line too long (98 > 79 characters) Line 47:80: E501 line too long (102 > 79 characters) Line 49:80: E501 line too long (82 > 79 characters) Line 50:80: E501 line too long (80 > 79 characters) Line 51:80: E501 line too long (89 > 79 characters)

In the file src/tespy/components/heat_exchangers/desuperheater.py:

Line 28:80: E501 line too long (98 > 79 characters) Line 29:80: E501 line too long (96 > 79 characters) Line 33:80: E501 line too long (102 > 79 characters) Line 34:80: E501 line too long (86 > 79 characters) Line 35:80: E501 line too long (91 > 79 characters) Line 36:80: E501 line too long (89 > 79 characters) Line 37:80: E501 line too long (89 > 79 characters)

In the file src/tespy/components/heat_exchangers/heat_exchanger.py:

Line 18:80: E501 line too long (81 > 79 characters) Line 38:80: E501 line too long (98 > 79 characters) Line 42:80: E501 line too long (102 > 79 characters) Line 43:80: E501 line too long (86 > 79 characters) Line 44:80: E501 line too long (91 > 79 characters) Line 45:80: E501 line too long (89 > 79 characters) Line 46:80: E501 line too long (89 > 79 characters)

In the file src/tespy/components/heat_exchangers/heat_exchanger_simple.py:

Line 38:80: E501 line too long (81 > 79 characters) Line 39:80: E501 line too long (83 > 79 characters) Line 51:80: E501 line too long (111 > 79 characters) Line 52:80: E501 line too long (108 > 79 characters) Line 53:80: E501 line too long (105 > 79 characters) Line 54:80: E501 line too long (110 > 79 characters) Line 306:80: E501 line too long (110 > 79 characters) Line 307:80: E501 line too long (119 > 79 characters)

In the file src/tespy/components/heat_exchangers/parabolic_trough.py:

Line 37:80: E501 line too long (111 > 79 characters) Line 38:80: E501 line too long (108 > 79 characters) Line 39:80: E501 line too long (100 > 79 characters)

In the file src/tespy/components/heat_exchangers/solar_collector.py:

Line 37:80: E501 line too long (111 > 79 characters) Line 38:80: E501 line too long (108 > 79 characters) Line 39:80: E501 line too long (98 > 79 characters)

In the file src/tespy/components/nodes/droplet_separator.py:

Line 32:80: E501 line too long (85 > 79 characters) Line 33:80: E501 line too long (94 > 79 characters) Line 34:80: E501 line too long (93 > 79 characters) Line 356:80: E501 line too long (80 > 79 characters)

In the file src/tespy/components/nodes/drum.py:

Line 25:80: E501 line too long (85 > 79 characters) Line 26:80: E501 line too long (94 > 79 characters) Line 27:80: E501 line too long (93 > 79 characters)

In the file src/tespy/components/piping/pipe.py:

Line 29:80: E501 line too long (111 > 79 characters) Line 30:80: E501 line too long (108 > 79 characters) Line 31:80: E501 line too long (105 > 79 characters) Line 32:80: E501 line too long (110 > 79 characters)

In the file src/tespy/components/reactors/water_electrolyzer.py:

Line 39:80: E501 line too long (90 > 79 characters) Line 40:80: E501 line too long (94 > 79 characters) Line 41:80: E501 line too long (101 > 79 characters) Line 42:80: E501 line too long (99 > 79 characters) Line 43:80: E501 line too long (100 > 79 characters) Line 52:80: E501 line too long (88 > 79 characters) Line 53:80: E501 line too long (93 > 79 characters) Line 54:80: E501 line too long (89 > 79 characters) Line 55:80: E501 line too long (112 > 79 characters)

In the file src/tespy/components/turbomachinery/compressor.py:

Line 41:80: E501 line too long (94 > 79 characters) Line 42:80: E501 line too long (81 > 79 characters) Line 43:80: E501 line too long (86 > 79 characters) Line 44:80: E501 line too long (84 > 79 characters)

In the file src/tespy/components/turbomachinery/pump.py:

Line 37:80: E501 line too long (94 > 79 characters)

In the file src/tespy/components/turbomachinery/turbine.py:

Line 38:80: E501 line too long (94 > 79 characters) Line 40:80: E501 line too long (80 > 79 characters)

In the file src/tespy/components/turbomachinery/turbomachine.py:

Line 33:80: E501 line too long (94 > 79 characters)

In the file src/tespy/networks/network.py:

Line 2092:80: E501 line too long (81 > 79 characters) Line 2299:80: E501 line too long (88 > 79 characters)

In the file src/tespy/tools/document_models.py:

Line 20:80: E501 line too long (81 > 79 characters)

In the file tests/test_components/test_turbomachinery.py:

Line 326:80: E501 line too long (80 > 79 characters) Line 338:80: E501 line too long (80 > 79 characters)