DLR-AE / CampbellViewer

Unified plotting tool for Campbell diagrams, processing results of wind turbine simulation tools HAWCStab2 and Bladed
Apache License 2.0
2 stars 1 forks source link

build: remove specific version for mplcursors dependency #80

Closed njoeres closed 1 year ago

njoeres commented 1 year ago

A fresh installation of CampbellViewer will fail due to the specific version mplcursors==0.5.1 in the setup file. If we don't specify the version, the installation will succeed. Not quite sure if this version is a hard requirement. It seems to work with the newest version as well.

hendrikverdonck commented 1 year ago

Why does the CampbellViewer installation fail? For me it works fine with the specific version in the setup file. However, the required version should not be 0.5.1, but 0.5.2 (which is the newest published version). With mplcursors versions <= 0.5.1, selecting lines in the campbell diagram will fail. Unfortunately, we currently have a strong dependency on the mplcursors package, because we use some of their methods to manually add highlights to the plot (highlighting in damping plot if line in frequency plot is selected).

njoeres commented 1 year ago

I noticed it, because the tests in the pipeline fail (see pipeline results here). I set up a fresh environment locally and got the same error. But if it works for you, I might did something wrong.

hendrikverdonck commented 1 year ago

Ok, and without specific version indication, the installation works for you locally? Can you try if it works with mplcursors==0.5.2?

njoeres commented 1 year ago

The problem seems to occur when upgrading to the newest pip version. You should be able to reproduce the error with the following steps (using the old setup mplcursors==0.5.1):

Upgrade to the newest version of pip (23.2.1): python -m pip install --upgrade pip Install CampbellViewer: pip install .

The error does not occur when using either mplcursors==0.5.2 or just mplcursors.

So maybe we can use either

mplcursors>=0.5.2 or mplcursors==0.5.2

in the setup.cfg file.

I'm using Python 3.9.12.

hendrikverdonck commented 1 year ago

Yes, alright, I'm in favor of using mplcursors==0.5.2