oemof / tespy

Thermal Engineering Systems in Python (TESPy). This package provides a powerful simulation toolkit for thermal engineering plants such as power plants, district heating systems or heat pumps.
https://tespy.readthedocs.io
MIT License
272 stars 85 forks source link

Missing char_map_func() documentation for Compressor #262

Closed jelic1marko closed 3 years ago

jelic1marko commented 3 years ago

The Compressor module appears to implement a function char_map_func() that is denoted in the documentation however, unlike other functions/equations of the compressor (e.g. pr_func() or eta_s_char_func()), the "tespy.components.turbomachinery.compressor.Compressor.char_map_func()" label does not appear to be a (hyper)link but rather static text. On the other hand, searching the documentation for "char_map_func()" appears to return no direct results but rather points to other methods like

hinting at (what I suppose are) specific implementations of a char_map_func() equation (see image below).

Should these specific implementatons potentially be documented in a centralized place that refers to how char_map_func() could be utilized to calculate pr or eta_s based on a characteristic map?

image

fwitte commented 3 years ago

Thank you for the hint, these methods were changed in the 0.4.0 version. It seems, I missed to update the link.

fwitte commented 3 years ago

Resolved by #263, you'll see the changes on the master branch with the next version release (scheduled for first week of May).