How to install when compiling from source?

[SpotlightKid]

I compiled KnobKraftOrm form source, from the latest Git, using the instructions in the readme.

I ran into some issues (see #452 & #453), but I was able to fix them locally.

What is the correct way to install the program when compiling form source?

If I run the build command I found in the Git workflow for the Ubuntu24 builds, I get a tarball, which contains a bin and lib folder under the root directory. If I install those somewhere in my home directory (e.g. ~/lib/KnobKraftOrm) and start ./KnobKraftOrm from ~/lib/KnobKraftOrm/bin, the program opens but it can't find the adaptations. The log pane says it can't find the adaptations directory:

17:12:11: info Launching KnobKraft Orm
17:12:11: Overriding built-in import category rules with file /home/chris/.config/KnobKraft/mapping_categories.jsonc
17:12:11: warning Directory given '/home/chris/lib/KnobKraftOrm/bin/adaptations' does not exist or is not a directory

But the tarball doesn't contain any such directory, the Python files are all in the bin directory.

If I create ~/lib/KnobKraftOrm/bin/adaptations and move all the *.py files and the (empty) sub-directory, which exist there, into the adaptations directory, I get Python errors like

17:09:46: info Launching KnobKraft Orm
17:09:46: Overriding built-in import category rules with file /home/chris/.config/KnobKraft/mapping_categories.jsonc
17:09:46: error Adaptation: Failure loading python module DSI_Mopho: AttributeError: module 'sequential' has no attribute 'GenericSequential'

regardless of wether the sequential directory exists in the adaptions directory or not.

[christofmuc]

The subdirectory sequential being empty is already the error.

The CMakeLists.txt in the adaptations directory contains this code in order to make the content of these directories part of the tarball:

	install(DIRECTORY sequential/ DESTINATION bin/sequential FILES_MATCHING PATTERN "__pycache__" EXCLUDE)
	install(DIRECTORY roland/ DESTINATION bin/roland FILES_MATCHING PATTERN "__pycache__" EXCLUDE)
	install(DIRECTORY knobkraft/ DESTINATION bin/knobkraft FILES_MATCHING PATTERN "__pycache__" EXCLUDE)
	install(DIRECTORY testing/ DESTINATION bin/testing FILES_MATCHING PATTERN "__pycache__" EXCLUDE)

But that does seem to only put the empty directories in the tarball, not the content?

That must be a regression, because in older versions that worked. I have a version 2.0.6 here on disk which clearly has the correct content. I'll file this as a bug.

To fix, you need to copy the whole directory tree with all Python files from the source into the target, the files inside the folders are required.

Thanks for the patience!

[SpotlightKid]

But that does seem to only put the empty directories in the tarball, not the content?

Yes, in the tarball download for the latest release these directories are also empty (same for the Ubuntu version).

I noticed that in the source folder these directories have Python files in them and copied over to my installation manually and that worked.

This is the content of the tarball:

$ tar tzf KnobKraft_Orm-2.6.2.1-Linux.tar.gz 
KnobKraft_Orm-2.6.2.1-Linux/lib/
KnobKraft_Orm-2.6.2.1-Linux/lib/libknobkraft-generic-adaptation.a
KnobKraft_Orm-2.6.2.1-Linux/bin/
KnobKraft_Orm-2.6.2.1-Linux/bin/DSI_Mopho.py
KnobKraft_Orm-2.6.2.1-Linux/bin/OberheimOBX.py
KnobKraft_Orm-2.6.2.1-Linux/bin/DSI_Mopho_X4.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Ensoniqesq1.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Waldorf Blofeld.py
KnobKraft_Orm-2.6.2.1-Linux/bin/DSI Pro 2.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Roland_MKS70V4.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Novation_UltraNova.py
KnobKraft_Orm-2.6.2.1-Linux/bin/KnobKraftOrm
KnobKraft_Orm-2.6.2.1-Linux/bin/Ensoniq_VFX.py
KnobKraft_Orm-2.6.2.1-Linux/bin/knobkraft/
KnobKraft_Orm-2.6.2.1-Linux/bin/Sequential Prophet 6.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Kawai K4.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Novation_Summit.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Sequential Prophet 5 Rev4.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Yamaha_TX7.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Waldorf_Kyra.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Waldorf_MicroWave.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Elektron_Digitone.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Roland JX-8P.py
KnobKraft_Orm-2.6.2.1-Linux/bin/AlesisAndromedaA6.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Akai_AX80.py
KnobKraft_Orm-2.6.2.1-Linux/bin/PioneerToraiz-AS1.py
KnobKraft_Orm-2.6.2.1-Linux/bin/ElectraOne.py
KnobKraft_Orm-2.6.2.1-Linux/bin/KawaiK1.py
KnobKraft_Orm-2.6.2.1-Linux/bin/RolandD50.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Sequential_Take_5.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Studiologic Sledge.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Elektron_AnalogRytm.py
KnobKraft_Orm-2.6.2.1-Linux/bin/JB_Solaris.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Roland_XV3080.py
KnobKraft_Orm-2.6.2.1-Linux/bin/sequential/
KnobKraft_Orm-2.6.2.1-Linux/bin/Moog_Voyager.py
KnobKraft_Orm-2.6.2.1-Linux/bin/YamahaDX7II.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Yamaha_TX81Z.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Oberheim_Teo5.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Behringer Deepmind 12.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Roland_JV80.py
KnobKraft_Orm-2.6.2.1-Linux/bin/KorgMS2000.py
KnobKraft_Orm-2.6.2.1-Linux/bin/YamahaRefaceDX.py
KnobKraft_Orm-2.6.2.1-Linux/bin/roland/
KnobKraft_Orm-2.6.2.1-Linux/bin/Matrix 6.py
KnobKraft_Orm-2.6.2.1-Linux/bin/OberheimOB8.py
KnobKraft_Orm-2.6.2.1-Linux/bin/OberheimOBX8.py
KnobKraft_Orm-2.6.2.1-Linux/bin/YamahaRefaceCP.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Sequential Pro 3.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Yamaha-YC-Series.py
KnobKraft_Orm-2.6.2.1-Linux/bin/DSI Prophet 12.py
KnobKraft_Orm-2.6.2.1-Linux/bin/GrooveSynthesis_3rdWave.py
KnobKraft_Orm-2.6.2.1-Linux/bin/YamahaDX7.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Novation_AStation.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Waldorf_M.py
KnobKraft_Orm-2.6.2.1-Linux/bin/DSI_Tetra.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Yamaha_FS1R.py
KnobKraft_Orm-2.6.2.1-Linux/bin/DSI Prophet 08.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Sequential Prophet X.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Roland_JV1080.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Line_6_POD_Series.py
KnobKraft_Orm-2.6.2.1-Linux/bin/OberheimOBXa.py
KnobKraft_Orm-2.6.2.1-Linux/bin/DSI_Evolver.py
KnobKraft_Orm-2.6.2.1-Linux/bin/QuasimidiCyber6.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Roland_TD-07.py
KnobKraft_Orm-2.6.2.1-Linux/bin/testing/
KnobKraft_Orm-2.6.2.1-Linux/bin/Emu_Morpheus.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Waldorf_Pulse.py
KnobKraft_Orm-2.6.2.1-Linux/bin/KorgMinilogue_XD.py
KnobKraft_Orm-2.6.2.1-Linux/bin/KorgDW8000.py
KnobKraft_Orm-2.6.2.1-Linux/bin/KorgDW6000.py
KnobKraft_Orm-2.6.2.1-Linux/bin/BC_Kijimi.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Korg_M1.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Korg_03RW.py
KnobKraft_Orm-2.6.2.1-Linux/bin/Zoom_MS.py

[christofmuc]

Fixed in master (change in CMakeLists.txt of adaptations) and released with 2.6.3. Thanks again for letting me know!

[SpotlightKid]

Forgive me, if I'm being dense, but isn't it necessary to move the Python files and packages into a adaptations sub-directory of the bin directory also? At least that's necessary if I build the software locally.

I can't really test the provided bianry packages, since my system (Arch/Manjaro Linux) already has libicuuc version 76.

[christofmuc]

No need to apologize, I appreciate anybody invested! I was happy because I looked how the previous Linux tar files looked like before my breaking change.

I also read the code setting up the search paths for Python, and it is:

		std::string command = "import sys\nsys.path.append(R\"" + getAdaptationDirectory().getFullPathName().toStdString() + "\")\n"
			+ "sys.path.append(R\"" + pathToTheOrm.getFullPathName().toStdString() + "\")\n" // This is where Linux searches
			+ "sys.path.append(R\"" + pathToTheOrm.getChildFile("adaptations").getFullPathName().toStdString() + "\")\n" // This is where we place the adaptation modules
			+ "sys.path.append(R\"" + pathToTheOrm.getChildFile("python").getFullPathName().toStdString() + "\")\n"; // This is the path in the Mac DMG

which to me says it should not matter if the files are in the adaptation subdirectory or directly in the same directory as the executable. But looking at this, I agree that it was probably intended that they are in the adaptation subdirectory. It is suprising though that it should not work if you copy the files into the same directory as the executable? This seems to need more investigation.