Installation
========================================================================================================================


Voraussetzungen
------------------------------------------------------------------------------------------------------------------------
Die Installation und der Betrieb von NCDiff hat nur sehr wenige Voraussetzungen:

* NCDiff Packet [#f1]_
* Windows:

  * Winzip / WinRar oder ähnliche Extrahierungssoftware
  * Python Version 3.6.x oder größer

* Linux/Unix/Mac OS X

  * ``unzip``
  * Python Version 3.6.x oder größer


Setup
------------------------------------------------------------------------------------------------------------------------
NCDiff wurde entworfen um eine möglichst einfache Installation zu gewährleisten. Das heißt im Wesentlichen wird das
Tool an die gewünschte Stelle kopiert und schon ist es einsatzbereit.
Wir gehen davon aus, dass Ihr Rechner mit dem Sie NCDiff betreiben wollen, bereits über die notwendige Voraussetzungen
verfügt.

* Wechseln Sie zum Ablageort des NCDiff Pakets.
* Extrahieren Sie das Packet nach Ihrem gewünschten Ausführungsort. Unter Windows erfolgt dies mit den notwendigen
  Clients und der Funktion
  ``„Extrahieren nach...“``
* Unter Unix/Linux/Macintosh erfolgt dies mit
  ``unzip NCDiff-X.Y.zip``
* Wechseln Sie nach ``NCDiff-X.Y``. Dies ist der Ordner von welchem aus NCDiff mit dem Befehl ``ncdiff`` gestartet
  werden kann.


Umgebungsvariablen
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Mit folgender Umgebungsvariable lässt sich das Verhalten von NCDiff beeinflussen:

    ``NCDIFF_CFGHOME``
        Das Verzeichnis in dem die Konfigurationsdateien von NCDiff liegen. Damit kann ein zentrales
        Konfigurationsverzeichnis verwendet werden wobei sich die Konfigurationsdateien ohne Pfadangabe benutzen lassen.

        Diese Variable muß, wenn gewünscht, vom Benutzer gesetzt werden.


Startskripte für NCDiff
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Falls ein bereits installierter Python Interpreter verwendet wird, so müssen diese Skripte eventuell angepasst werden.


Microsoft Windows
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
Unter Windows existieren als Startskripte ``ncdiff.cmd`` und ``ncdiff-launcher.cmd``.
Das Skript ``ncdiff.cmd`` dient dazu NCDiff in einer Kommandozeilenumgebung zu verwenden.

Das Skript ``ncdiff-launcher.cmd`` dient dazu eine Graphische Benutzeroberfläche für NCDiff zu starten. Um einen Eintrag
für NCDiff ins Startmenü setzten zu können gibt es die Verknüpfung ``NCDiff.lnk``. In den Eigenschaften der Verknüpfung
muss gegebenenfalls der Pfad zum NCDiff Installationsverzeichnis angepasst werden, beispielsweise:

.. image:: img/installation_windows_link.png

Damit NCDiff unter Windows lauffähig ist muss weiters eine der drei Voraussetzungen erfüllt sein:

#. ``python.exe`` und ``pythonw.exe`` befinden sich im Systempfad.
   Sollte sich der installierte Python Interpreter nicht bereits im Systempfad befinden so sollte dieser um den Pfad zum
   Python Interpreter erweitert werden. Das ist über die Systemsteuerung möglich:

   .. image:: img/installation_windows_systemsteuerung.png

#. Eine Portable Python Installation liegt im Installationsverzeichnis von NCDiff als Unterordner ``python``.
#. In den Startskripten ``ncdiff.cmd`` und ``ncdiff-launcher.cmd`` wird die Umgebungsvariable ``NCDIFF_PYTHONHOME``
   auf eine Python Installation gesetzt. Beispielsweise: ``NCDIFF_PYTHONHOME=C:\Python37\``


Linux/Unix/Mac OS X
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
Unter Linux/Unix/Mac OS X existieren als Startskripte ``ncdiff`` und ``ncdiff-launcher``. Bei beiden Skripten handelt
es sich um Shell Skripte welche zur Ausführung ``/bin/sh`` verwenden.
Das Skript ``ncdiff`` dient dazu NCDiff in einem Terminal zu verwenden.
Das Skript ``ncdiff-launcher`` dient dazu eine Graphische Benutzeroberfläche für NCDiff zu starten.
Damit NCDiff mit diesen Skripten lauffähig ist muss eine der folgenden Vorraussetzugen erfüllt sein:

1. Der Python Interpreter python befindet sich im Pfad.
2. Im Installationsverzeichnis von NCDiff wird eine Python Installation in python abgelegt oder mit einer eine
   symbolische Verknüpfung darauf verwiesen.
   Beispielsweise: ``ln –s /opt/python-3.7 python``
3. In den Startskripten ``ncdiff.cmd`` und ``ncdiff-launcher.cmd`` wird die Umgebungsvariable ``NCDIFF_PYTHONHOME``
   auf eine Python Installation gesetzt.
   Beispielsweise: ``NCDIFF_PYTHONHOME=/opt/python-3.7/bin``


.. rubric:: Fußnoten

.. [#f1] Sollten wir Ihr Interesse an NCDiff geweckt haben und Sie noch kein ausführbares Packet besitzen
         kontaktieren Sie uns bitte unter info@ncdiff.online