Skip to content

Latest commit

 

History

History
533 lines (424 loc) · 19.6 KB

installation.md

File metadata and controls

533 lines (424 loc) · 19.6 KB

Installation

English (Installation):

MAVIS (aka Xc++ 2) is currently under development and is not fully available in this repository. Cloning the repository will only give you the README file, some images and already released code, including the user interface (UI) compatible with Qwen 2.5 Code and Llama 3.2 Vision.

Note: Although manual installation is not much more complicated, it is significantly more stable and secure, so we recommend preferring this method.

The automatic installation installs Git, Python and Ollama, creates a folder and sets up a virtual Python environment. It also installs the required Python frameworks and AI models - but this step is also done automatically with the manual installation.

Automatic Installation (experimental)

If you still prefer the automatic installation, please follow the instructions below:

Installation

Automatic Installation on Windows

  1. Download the installation file:
  1. Run the installation file:
  • Run the downloaded file by double-clicking it.
  1. Accept security warnings:
  • If Windows issues a security warning, accept it and allow execution.
  1. Follow the installation instructions:
  • Follow the on-screen instructions to install MAVIS.

Starting the UI

Start the UI After installation, you can start MAVIS. There are several start options that vary depending on the version and intended use:

  • All MAVIS versions:
    • run-mavis-all.bat (experimental)
  • With a batch file for MAVIS 1.2:
    • run-mavis-1-2-main.bat (recommended)
    • run-mavis-1-2-code.bat (recommended)
    • run-mavis-1-2-code-pro.bat (recommended)
    • run-mavis-1-2-math.bat (recommended)
    • run-mavis-1-2-math-pro.bat (recommended)
    • run-mavis-1-2-mini.bat (recommended)
    • run-mavis-1-2-mini-mini.bat (recommended)
    • run-mavis-1-2-3-main.bat (recommended)
    • run-mavis-1-2-3-math.bat (recommended)
    • run-mavis-1-2-3-math-pro.bat (recommended)
    • run-mavis-1-2-3-math-ultra.bat (recommended)
  • for MAVIS 1.3 EAP:
    • run-mavis-1-3-main.bat (experimental)
    • run-mavis-1-3-code.bat (experimental)
    • run-mavis-1-3-code-pro.bat (experimental)
    • run-mavis-1-3-math.bat (experimental)
    • run-mavis-1-3-math-pro.bat (experimental)
  • for MAVIS 1.4 EAP:
    • run-mavis-1-4-math.bat (experimental)

Have fun with MAVIS 🚀

Automatic Installation on macOS/Linux

  1. Download the installation file:
  1. Make the file executable:
  • Open a terminal and navigate to the directory where the downloaded file is located.
  • Enter the following command:
chmod +x mavis-installer.sh
  1. Run the installation file:
  • Start the installation with:
./mavis-installer.sh
  1. Follow the installation instructions:
  • Follow the instructions in the terminal to install MAVIS.

Start UI

Start the UI After installation, you can start MAVIS. There are several start options that vary depending on the version and intended use:

  • All MAVIS versions:
    • run-mavis-all.sh (experimental)
  • With a shell file for MAVIS 1.2:
    • run-mavis-1-2-main.sh (recommended)
    • run-mavis-1-2-code.sh (recommended)
    • run-mavis-1-2-code-pro.sh (recommended)
    • run-mavis-1-2-math.sh (recommended)
    • run-mavis-1-2-math-pro.sh (recommended)
    • run-mavis-1-2-mini.sh (recommended)
    • run-mavis-1-2-mini-mini.sh (recommended)
    • run-mavis-1-2-3-main.sh (recommended)
    • run-mavis-1-2-3-math.sh (recommended)
    • run-mavis-1-2-3-math-pro.sh (recommended)
    • run-mavis-1-2-3-math-ultra.sh (recommended)
  • for MAVIS 1.3 EAP:
    • run-mavis-1-3-main.sh (experimental)
    • run-mavis-1-3-code.sh (experimental)
    • run-mavis-1-3-code-pro.sh (experimental)
    • run-mavis-1-3-math.sh (experimental)
    • run-mavis-1-3-math-pro.sh (experimental)
  • for MAVIS 1.4 EAP:
    • run-mavis-1-4-math.sh (experimental)

Have fun with MAVIS 🚀

Manual Installation (recommended)

Prerequisites

To successfully install MAVIS, you need the following programs:

  1. Git
    Download Git from the official website: https://git-scm.com/downloads

  2. Python
    Recommended: Python 3.12 (3.11 is also supported - not Python 3.13 yet). Download Python from the https://www.python.org/downloads/ or from the Microsoft Store.

  3. Ollama
    Ollama is a tool required for MAVIS. Install Ollama from the official website: https://ollama.com/download

Installation

The necessary Python frameworks and AI models are automatically installed during manual installation.

Windows

  1. Create folder
    Create a folder named PycharmProjects (C:\Users\DeinBenutzername\PycharmProjects) if it doesn't already exist. The location and method vary depending on your operating system:

    • Option 1: Via File Explorer

      1. Open File Explorer.
      2. Navigate to C:\Users\YourUsername\.
      3. Create a folder there called PycharmProjects.

    • Option 2: Using the Command Prompt
      Open the command prompt and run the following commands:

      mkdir C:\Users\%USERNAME%\PycharmProjects
cd C:\Users\%USERNAME%\PycharmProjects

  2. Clone repository
    Clone the repository to a local directory:

    git clone https://github.com/Peharge/MAVIS

  3. Change directory
    Navigate to the project directory:

    cd MAVIS

  4. Create Python virtual environment
    Set up a virtual environment to install dependencies in isolation:

    python -m venv env

    (You can Do not replace env with another name!)

Starting the UI

Start the UI After installation, you can start MAVIS. There are several start options that vary depending on the version and intended use:

  • All MAVIS versions:
    • run-mavis-all.bat (experimental)
  • With a batch file for MAVIS 1.2:
    • run-mavis-1-2-main.bat (recommended)
    • run-mavis-1-2-code.bat (recommended)
    • run-mavis-1-2-code-pro.bat (recommended)
    • run-mavis-1-2-math.bat (recommended)
    • run-mavis-1-2-math-pro.bat (recommended)
    • run-mavis-1-2-mini.bat (recommended)
    • run-mavis-1-2-mini-mini.bat (recommended)
    • run-mavis-1-2-3-main.bat (recommended)
    • run-mavis-1-2-3-math.bat (recommended)
    • run-mavis-1-2-3-math-pro.bat (recommended)
    • run-mavis-1-2-3-math-ultra.bat (recommended)
  • for MAVIS 1.3 EAP:
    • run-mavis-1-3-main.bat (experimental)
    • run-mavis-1-3-code.bat (experimental)
    • run-mavis-1-3-code-pro.bat (experimental)
    • run-mavis-1-3-math.bat (experimental)
    • run-mavis-1-3-math-pro.bat (experimental)
  • for MAVIS 1.4 EAP:
    • run-mavis-1-4-math.bat (experimental)

Have fun with MAVIS 🚀

macOS/Linux

  1. Create a folder
    Create a folder called PycharmProjects (~/PycharmProjects) if it doesn't already exist. The location and method vary depending on your operating system:

    • Option 1: Via the File Manager

      1. Open the File Manager.
      2. Navigate to your home directory (~/).
      3. Create a folder called PycharmProjects there.

    • Option 2: Via Terminal
      Open Terminal and run the following commands:

      mkdir -p ~/PycharmProjects
cd ~/PycharmProjects

  2. Clone repository
    Clone the repository to a local directory:

    git clone https://github.com/Peharge/MAVIS

  3. Change directory
    Navigate to the project directory:

    cd MAVIS

  4. Create Python virtual environment
    Set up a virtual environment to install dependencies in isolation:

    python -m venv env

    (You cannot replace env with any other name!)

Start UI

Start the UI After installation, you can start MAVIS. There are several start options that vary depending on the version and intended use:

  • All MAVIS versions:
    • run-mavis-all.sh (experimental)
  • With a shell file for MAVIS 1.2:
    • run-mavis-1-2-main.sh (recommended)
    • run-mavis-1-2-code.sh (recommended)
    • run-mavis-1-2-code-pro.sh (recommended)
    • run-mavis-1-2-math.sh (recommended)
    • run-mavis-1-2-math-pro.sh (recommended)
    • run-mavis-1-2-mini.sh (recommended)
    • run-mavis-1-2-mini-mini.sh (recommended)
    • run-mavis-1-2-3-main.sh (recommended)
    • run-mavis-1-2-3-math.sh (recommended)
    • run-mavis-1-2-3-math-pro.sh (recommended)
    • run-mavis-1-2-3-math-ultra.sh (recommended)
  • for MAVIS 1.3 EAP:
    • run-mavis-1-3-main.sh (experimental)
    • run-mavis-1-3-code.sh (experimental)
    • run-mavis-1-3-code-pro.sh (experimental)
    • run-mavis-1-3-math.sh (experimental)
    • run-mavis-1-3-math-pro.sh (experimental)
  • for MAVIS 1.4 EAP:
    • run-mavis-1-4-math.sh (experimental)

Have fun with MAVIS 🚀

Deutsch (Installation):

MAVIS (alias Xc++ 2) befindet sich derzeit in der Entwicklung und ist in diesem Repository nicht vollständig verfügbar. Durch das Klonen des Repositories erhalten Sie lediglich die README-Datei, einige Bilder und bereits veröffentlichte Codes, einschließlich der Benutzeroberfläche (UI), die mit Qwen 2.5 Code und Llama 3.2 Vision kompatibel ist.

Hinweis: Die manuelle Installation ist zwar nicht wesentlich komplizierter, jedoch erheblich stabiler und sicherer. Deshalb empfehlen wir, diese Methode zu bevorzugen.

Bei der automatischen Installation werden Git, Python und Ollama installiert, ein Ordner erstellt und eine virtuelle Python-Umgebung eingerichtet. Außerdem werden die erforderlichen Python-Frameworks und KI-Modelle installiert – dieser Schritt erfolgt jedoch auch bei der manuellen Installation automatisch.

Automatische Installation (experimentell)

Solltest du dennoch die automatische Installation bevorzugen, folge bitte den untenstehenden Anweisungen:

Installation

Automatische Installation auf Windows

  1. Herunterladen der Installationsdatei:

  2. Installationsdatei ausführen:

    • Führen Sie die heruntergeladene Datei durch Doppelklick aus.

  3. Sicherheitswarnungen akzeptieren:

    • Falls Windows eine Sicherheitswarnung ausgibt, bestätigen Sie diese und erlauben Sie die Ausführung.

  4. Installationsanweisungen befolgen:

    • Folgen Sie den Anweisungen auf dem Bildschirm, um MAVIS zu installieren.

Benutzeroberfläche starten

Starten der UI

Nach der Installation können Sie MAVIS starten. Es gibt mehrere Startoptionen, die je nach Version und Verwendungszweck variieren:

  • Alle MAVIS Versionen:
    • run-mavis-all.bat (experimentell)
  • Mit einer Batch-Datei für MAVIS 1.2:
    • run-mavis-1-2-main.bat (empfohlen)
    • run-mavis-1-2-code.bat (empfohlen)
    • run-mavis-1-2-code-pro.bat (empfohlen)
    • run-mavis-1-2-math.bat (empfohlen)
    • run-mavis-1-2-math-pro.bat (empfohlen)
    • run-mavis-1-2-mini.bat (empfohlen)
    • run-mavis-1-2-mini-mini.bat (empfohlen)
    • run-mavis-1-2-3-main.bat (empfohlen)
    • run-mavis-1-2-3-math.bat (empfohlen)
    • run-mavis-1-2-3-math-pro.bat (empfohlen)
    • run-mavis-1-2-3-math-ultra.bat (empfohlen)
  • für MAVIS 1.3 EAP:
    • run-mavis-1-3-main.bat (experimentell)
    • run-mavis-1-3-code.bat (experimentell)
    • run-mavis-1-3-code-pro.bat (experimentell)
    • run-mavis-1-3-math.bat (experimentell)
    • run-mavis-1-3-math-pro.bat (experimentell)
  • für MAVIS 1.4 EAP:
    • run-mavis-1-4-math.bat (experimentell)

Viel Spaß mit MAVIS 🚀

###mAutomatische Installation auf macOS/Linux

  1. Herunterladen der Installationsdatei:

  2. Datei ausführbar machen:

    • Öffnen Sie ein Terminal und navigieren Sie in das Verzeichnis, in dem sich die heruntergeladene Datei befindet.
    • Geben Sie folgenden Befehl ein: 
      chmod +x mavis-installer.sh

  3. Installationsdatei ausführen:

    • Starten Sie die Installation mit: 
      ./mavis-installer.sh

  4. Installationsanweisungen befolgen:

    • Folgen Sie den Anweisungen im Terminal, um MAVIS zu installieren.

Benutzeroberfläche starten

Starten der UI

Nach der Installation können Sie MAVIS starten. Es gibt mehrere Startoptionen, die je nach Version und Verwendungszweck variieren:

  • Alle MAVIS Versionen:
    • run-mavis-all.sh (experimentell)
  • Mit einer shell-Datei für MAVIS 1.2:
    • run-mavis-1-2-main.sh (empfohlen)
    • run-mavis-1-2-code.sh (empfohlen)
    • run-mavis-1-2-code-pro.sh (empfohlen)
    • run-mavis-1-2-math.sh (empfohlen)
    • run-mavis-1-2-math-pro.sh (empfohlen)
    • run-mavis-1-2-3-main.sh (empfohlen)
    • run-mavis-1-2-3-math.sh (empfohlen)
    • run-mavis-1-2-3-math-pro.sh (empfohlen)
    • run-mavis-1-2-3-math-ultra.sh (empfohlen)
  • für MAVIS 1.3 EAP:
    • run-mavis-1-3-main.sh (experimentell)
    • run-mavis-1-3-code.sh (experimentell)
    • run-mavis-1-3-code-pro.sh (experimentell)
    • run-mavis-1-3-math.sh (experimentell)
    • run-mavis-1-3-math-pro.sh (experimentell)
  • für MAVIS 1.4 EAP:
    • run-mavis-1-4-math.sh (experimentell)

Viel Spaß mit MAVIS 🚀

Manuelle Installation (empfohlen)

Voraussetzungen

Um MAVIS erfolgreich zu installieren, benötigen Sie die folgenden Programme:

  1. Git
    Laden Sie Git von der offiziellen Website herunter: https://git-scm.com/downloads

  2. Python
    Empfohlen: Python 3.12 (auch 3.11 wird unterstützt - noch nicht Python 3.13). Laden Sie Python von der https://www.python.org/downloads/ oder über den Microsoft Store herunter.

  3. Ollama
    Ollama ist ein Tool, das für MAVIS erforderlich ist. Installieren Sie Ollama von der offiziellen Website: https://ollama.com/download

Installation

Die erforderlichen Python-Frameworks und KI-Modelle werden bei der manuellen Installation automatisch mitinstalliert.

Windows

  1. Ordner erstellen
    Erstelle einen Ordner mit dem Namen PycharmProjects (C:\Users\DeinBenutzername\PycharmProjects), falls dieser noch nicht existiert. Der Speicherort und die Methode variieren je nach Betriebssystem:

    • Option 1: Über den Datei-Explorer

      1. Öffne den Datei-Explorer.
      2. Navigiere zu C:\Users\DeinBenutzername\.
      3. Erstelle dort einen Ordner namens PycharmProjects.

    • Option 2: Über die Eingabeaufforderung (Command Prompt) Öffne die Eingabeaufforderung und führe die folgenden Befehle aus:

      mkdir C:\Users\%USERNAME%\PycharmProjects
cd C:\Users\%USERNAME%\PycharmProjects

  2. Repository klonen Klonen Sie das Repository in ein lokales Verzeichnis:

    git clone https://github.com/Peharge/MAVIS

  3. In das Verzeichnis wechseln Navigieren Sie in das Projektverzeichnis:

    cd MAVIS

  4. Virtuelle Python-Umgebung erstellen Richten Sie eine virtuelle Umgebung ein, um Abhängigkeiten isoliert zu installieren:

    python -m venv env

    (Sie können env nicht durch einen anderen Namen ersetzen!)

Benutzeroberfläche starten

Starten der UI

Nach der Installation können Sie MAVIS starten. Es gibt mehrere Startoptionen, die je nach Version und Verwendungszweck variieren:

  • Alle MAVIS Versionen:
    • run-mavis-all.bat (experimentell)
  • Mit einer Batch-Datei für MAVIS 1.2:
    • run-mavis-1-2-main.bat (empfohlen)
    • run-mavis-1-2-code.bat (empfohlen)
    • run-mavis-1-2-code-pro.bat (empfohlen)
    • run-mavis-1-2-math.bat (empfohlen)
    • run-mavis-1-2-math-pro.bat (empfohlen)
    • run-mavis-1-2-mini.bat (empfohlen)
    • run-mavis-1-2-mini-mini.bat (empfohlen)
    • run-mavis-1-2-3-main.bat (empfohlen)
    • run-mavis-1-2-3-math.bat (empfohlen)
    • run-mavis-1-2-3-math-pro.bat (empfohlen)
    • run-mavis-1-2-3-math-ultra.bat (empfohlen)
  • für MAVIS 1.3 EAP:
    • run-mavis-1-3-main.bat (experimentell)
    • run-mavis-1-3-code.bat (experimentell)
    • run-mavis-1-3-code-pro.bat (experimentell)
    • run-mavis-1-3-math.bat (experimentell)
    • run-mavis-1-3-math-pro.bat (experimentell)
  • für MAVIS 1.4 EAP:
    • run-mavis-1-4-math.bat (experimentell)

Viel Spaß mit MAVIS 🚀

macOS/Linux

  1. Ordner erstellen
    Erstelle einen Ordner mit dem Namen PycharmProjects (~/PycharmProjects), falls dieser noch nicht existiert. Der Speicherort und die Methode variieren je nach Betriebssystem:

    • Option 1: Über den Datei-Manager

      1. Öffne den Datei-Manager.
      2. Navigiere zu deinem Home-Verzeichnis (~/).
      3. Erstelle dort einen Ordner namens PycharmProjects.

    • Option 2: Über das Terminal Öffne das Terminal und führe die folgenden Befehle aus:

      mkdir -p ~/PycharmProjects
cd ~/PycharmProjects

  2. Repository klonen Klonen Sie das Repository in ein lokales Verzeichnis:

    git clone https://github.com/Peharge/MAVIS

  3. In das Verzeichnis wechseln Navigieren Sie in das Projektverzeichnis:

    cd MAVIS

  4. Virtuelle Python-Umgebung erstellen Richten Sie eine virtuelle Umgebung ein, um Abhängigkeiten isoliert zu installieren:

    python -m venv env

    (Sie können env nicht durch einen anderen Namen ersetzen!)

Benutzeroberfläche starten

Starten der UI

Nach der Installation können Sie MAVIS starten. Es gibt mehrere Startoptionen, die je nach Version und Verwendungszweck variieren:

  • Alle MAVIS Versionen:
    • run-mavis-all.sh (experimentell)
  • Mit einer shell-Datei für MAVIS 1.2:
    • run-mavis-1-2-main.sh (empfohlen)
    • run-mavis-1-2-code.sh (empfohlen)
    • run-mavis-1-2-code-pro.sh (empfohlen)
    • run-mavis-1-2-math.sh (empfohlen)
    • run-mavis-1-2-math-pro.sh (empfohlen)
    • run-mavis-1-2-mini.sh (empfohlen)
    • run-mavis-1-2-mini-mini.sh (empfohlen)
    • run-mavis-1-2-3-main.sh (empfohlen)
    • run-mavis-1-2-3-math.sh (empfohlen)
    • run-mavis-1-2-3-math-pro.sh (empfohlen)
    • run-mavis-1-2-3-math-ultra.sh (empfohlen)
  • für MAVIS 1.3 EAP:
    • run-mavis-1-3-main.sh (experimentell)
    • run-mavis-1-3-code.sh (experimentell)
    • run-mavis-1-3-code-pro.sh (experimentell)
    • run-mavis-1-3-math.sh (experimentell)
    • run-mavis-1-3-math-pro.sh (experimentell)
  • für MAVIS 1.4 EAP:
    • run-mavis-1-4-math.sh (experimentell)

Viel Spaß mit MAVIS 🚀