|
| 1 | +# QualCoder Installation and running instructions |
| 2 | + |
| 3 | +## INSTALLATION |
| 4 | + |
| 5 | +For the manual installations (using the command line or terminal) I mention a specific release version, for example version 3.6. Please check on the [releases page](https://github.com/ccbogel/QualCoder/releases) for the most current version, as it may be newer. |
| 6 | + |
| 7 | +### Prerequisites |
| 8 | +VLC is optional, but you will need it installed if you need to do any audio/video coding. Optionally, install ffmpeg for speech to text and waveform display, see https://phoenixnap.com/kb/ffmpeg-windows.. |
| 9 | + |
| 10 | +### Windows |
| 11 | + |
| 12 | +See [https://github.com/ccbogel/QualCoder/releases/3.7](https://github.com/ccbogel/QualCoder/releases/3.7) |
| 13 | + |
| 14 | +You have two options for executables, created on Windows 11, and may work on Windows 10: |
| 15 | + |
| 16 | +- There is a Windows installer on the release page called: **QualCoder.Win.3.7.exe** |
| 17 | + |
| 18 | +- There is a standalone, non-installable exe folder called: **QualCoder.Win.3.7.Portable.zip** Download and unzip. It is in a folder alongside an internal folder. These both must be together or the exe will not run. Double-click the QualCoder exe to run, it takes up to 20 seconds to start. |
| 19 | + |
| 20 | +Standalone, portable version: <img width="100" height="60" alt="QualCoder portable" src="https://github.com/user-attachments/assets/6be1de98-8b47-4d57-b4b5-c34375e44959" /> |
| 21 | + |
| 22 | +On first use of the exe, Windows may ask you to allow to run QualCoder. This is because it is from an unknown publisher. It costs a lot of money to get a trusted publisher certificate - so that will not be possible for the foreseeable future. If you are uncomfortable with these warnings install from the source as detailed next. |
| 23 | + |
| 24 | +Alternatively, install from source code: |
| 25 | + |
| 26 | +Download the source code. Read and apply the section for Windows source code usage in the **Readme.md** file. |
| 27 | +Remove the back ticks that surround the command line instructions ` as these are used for display only. |
| 28 | + |
| 29 | +### MacOS |
| 30 | + |
| 31 | +**Install from App bundles:** |
| 32 | + |
| 33 | +Make sure you have installed any MAC OS updates before starting the installation. Go to the System Settings app on your Mac. Click General in the sidebar (you may need to scroll down), then click Software Update. |
| 34 | + |
| 35 | +Install QualCoder: Double-click the downloaded dmg-file. Drag QualCoder into the link to your applications. |
| 36 | + |
| 37 | +Start QualCoder from your Launchpad or by double-clicking the app within your applications folder. |
| 38 | +We are currently not able to sign the app bundles, so when you first try to run the program, you may get a pop-up warning that QualCoder is from an unregistered developer or "QualCoder can't be opened because Apple cannot check it for malicious software." Depending on your processor, you may see one of these: |
| 39 | + |
| 40 | +If you see "Show in Finder" or OK. Click Ok. |
| 41 | + |
| 42 | +If you see "Done" or "Move to trash. Click "Done. |
| 43 | + |
| 44 | +Next, go to Settings and select Privacy and Security. Scroll down until you see a message stating QualCoder was prevented from starting. Click on "open anyway". You may be prompted to enter your password and may need to click "Open" again. After entering your password, just wait for the program to open up. It may take several seconds. |
| 45 | + |
| 46 | +From now on, QualCoder should start without issues. |
| 47 | + |
| 48 | +**Install from source code:** |
| 49 | + |
| 50 | +Download the source code. Read and apply the section for masOC source code usage in the **Readme.md** file. |
| 51 | +Remove the back ticks that surround the command line instructions ` as these are used for display only. |
| 52 | + |
| 53 | + |
| 54 | +### Debian/Ubuntu Linux |
| 55 | + |
| 56 | +There is an executable file in the releases page for Ubuntu 24.04 for the 3.6 release. Download and double click to run. |
| 57 | + |
| 58 | +Alternatively, run QualCoder from the source code: |
| 59 | + |
| 60 | +Download the source code. Read and apply the section for Ubuntu source code usage in the **Readme.md** file. |
| 61 | +Remove the back ticks that surround the command line instructions ` as these are used for display only. |
| 62 | + |
| 63 | +### Fedora 43 |
| 64 | + |
| 65 | +These instructions are tested with QualCoder 3.7 on Fedora 43 with Python 3.12.12. |
| 66 | + |
| 67 | +Install dependencies: |
| 68 | + |
| 69 | +`sudo dnf install python3.12` |
| 70 | + |
| 71 | +Set up QualCoder: |
| 72 | + |
| 73 | +`cd ~/qualcoder # replace with appropriate location on your machine` |
| 74 | + |
| 75 | +`python3.12 -m venv env` |
| 76 | + |
| 77 | +`source env/bin/activate` |
| 78 | + |
| 79 | +`python3.12 -m ensurepip` |
| 80 | + |
| 81 | +`python3.12 -m pip install --upgrade pip` |
| 82 | + |
| 83 | +`mkdir tmp` |
| 84 | + |
| 85 | +`TMPDIR=./tmp python3.12 -m pip install -r requirements.txt` |
| 86 | + |
| 87 | +`deactivate` |
| 88 | + |
| 89 | +Usage: |
| 90 | + |
| 91 | +`cd ~/qualcoder # replace with appropriate location on your machine` |
| 92 | + |
| 93 | +`source env/bin/activate` |
| 94 | + |
| 95 | +`cd src` |
| 96 | + |
| 97 | +`python3.12 -m qualcoder` |
| 98 | + |
| 99 | +### Fedora 42 |
| 100 | + |
| 101 | +These instructions download the current source code directly from GitHub. Note: Fedora uses Wayland which may not work well with the Qt graphical interface. It is suggested you also install Xwayland. |
| 102 | + |
| 103 | +Download the source code. Read and apply the section for Fedora source code usage in the **Readme.md** file. |
| 104 | +Remove the back ticks that surround the command line instructions ` as these are used for display only. |
| 105 | + |
| 106 | +There may be problems with QualCoder working with audio / video in Fedora. |
| 107 | + |
| 108 | +### Arch/Manjaro Linux |
| 109 | + |
| 110 | +Download the source code. Read and apply the section for Arch source code usage in the **Readme.md** file. |
| 111 | +Remove the back ticks that surround the command line instructions ` as these are used for display only. |
| 112 | + |
0 commit comments