🚀 Install PC users

Your CONFIGURATION will be saved each time you click the « Start » button and when you close the KaraFan application.

I've developed this project with GUI in mind and it works on your PC !

✅ Installation

KaraFan is very easy to install :

1️⃣ Choose a folder

... on your PC where you wish to store the « KaraFan » project and Go inside it.

2️⃣ Install Python

💻 Windows

Download :

• Install.exe <-- The easiest way ! (auto-extract the BAT)
• Install.zip <-- Bypass the Browser Security
• Install.bat <-- Click to show, save it and rename to « Install.bat »

It will do all the dirty cheat for you !

Tested on VirusTotal : Install.exe , Install.zip , Install.bat

Note

If you have installed Python 3.11 before WITHOUT using this Install.bat, you must uninstall it before !
Even those installed with the Microsoft Store !

Important

On Windows 11, you must allow first the execution of the BAT file :

1. Right-click on the file
2. Choose « Properties »
3. In the « General » tab, click on the « Unlock » button
4. Click on the « OK » button

Warning

You must execute it with Administrator Rights :

1. Right-click on the file
2. Choose to :
   
3. Click on the « Yes » button

---

💻 Linux --> untested !

You have to install it manually on your system :

sudo apt install -y python3.11

Warning

If you have an AMD GPU, you must install the ROCm driver : ROCm
Then you have to install first PyTorch with the following command :

pip3 install torch --index-url https://download.pytorch.org/whl/rocm5.6

💻 Mac OS X --> ... in progress !

You have to install it manually from the official website : Python 3.11

Warning

If you don't have a GPU (Silicon or AMD), all programs that use PyTorch (including KaraFan) will run on the CPU : it will be slower than with a GPU.

Note

For more informations, follow this link ...

---

Then for Linux and Mac OS X :

1. Right-click on this link --> Setup.py
2. Choose « Save target link as ... »
3. Save it in the folder you have chosen.

So ...

3️⃣ Run « Setup.py » by double-clicking on it.

After the install, there will be 3 new files in the folder you have chosen :

• KaraFan.pyw : to Launch the application in pure GUI.
• Setup.py : to update the application.
• Install.bat : <-- you can remove it, if you wish ...

4️⃣ Now, you can launch « KaraFan.pyw » by double-clicking on it.

That's it, Enjoy !! 😎

(PLEASE : Report me Bugs in private message on Discord, or post a new issue on GitHub)

✅ How To Update ?

Simply Run :

the « Setup.py » file !

What else ... ?

---

📂 STRUCTURE

After installation, you'll find new folders at the root of the folder you have chosen with the following structure :

Folder	Function
/ KaraFan	The main application
/ KaraFan_user	Where config file & FFmpeg executable are saved
/ KaraFan_user / Models	Where all the models are stored
/ KaraFan_user / Multi_Song	If you want to test SDR with your own recipes
/ Music	Here you can put your audio files (or choose another one)
/ Results	Here you will find your extracted audio files (or another one)

~

---