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

Native binary installers are available at https://www.enthought.com/products/edm/installers/ for the following platforms:

* ``.msi`` for Windows
* ``.pkg`` and ``.sh`` for macOS
* ``.deb`` for Debian/Ubuntu
* ``.rpm`` for RHEL/Centos/Fedora
* ``.sh`` for Generic glibc Linux


GUI frontend
------------

EDM 2.x.x installers exist in two flavors: ``full`` and ``cli only``. Both
install the EDM command-line tool (CLI). The ``full`` installers also contain
the new EDM GUI frontend interface, an electron-based application to discover,
install, and remove `EDM application distribution bundles`_. The ``cli only``
installers (named ``edm_cli``) do not include the GUI frontend. More
information about the GUI frontend is available at `EDM GUI frontend
documentation`_


.. warning::

   - If you are updating from a version of EDM prior to 1.10,
     please uninstall the prior installation first. If you are updating from version
     1.10 or later, and are installing *to the same location* as the earlier
     version, then this is not required.

   - Python environments created by EDM contain entry points that
     refer back to the edm installation folder. As a result installing
     a new EDM version in a different folder will cause problems with
     edm operations in old environments. The environment is still
     functional, however EDM will not be able to install/update and
     remove packages for that enviroment any more.


Debian/Ubuntu
-------------

To install the ``deb`` package please use::

  $ dpkg -i edm_3.0.1_x86_64.deb


.. note::

   - Installing requires superuser privileges

RHEL/Centos/Fedora
------------------

To install the ``.rpm`` package please use::

   $ rpm -Uvh edm_3.0.1_x86_64.rpm

.. note::

   - Installing requires superuser privileges


Generic glibc Linux
-------------------

To install EDM using the ``.sh`` installer please use

::

 $ sh edm_cli_3.0.1_linux_x86_64.sh

Follow the directions in the console.

.. note::

   - Using the generic linux installer the user can control
     the path to install the EDM application.


Windows
-------

Windows installers support ``per-machine`` and ``per-user`` installation setups.


.. image:: images/windows_setup.png

- A ``per-user`` install, i.e. when ``Install EDM for all users`` is
  not checked, means that the edm binaries will be stored in your own
  user profile on this machine, not usable by other users on the
  machine.
- A ``per-machine`` install, i.e. when ``Install EDM for all users``
  is checked, means that the edm binaries will be stored in a global
  folder (e.g. ``c:\Enthought\edm``) and available to all users who
  have an account on this machine.


Install using msiexec
^^^^^^^^^^^^^^^^^^^^^

Installation can be automated using ``msiexec``

examples:

using Windows PowerShell::

  msiexec.exe /qr /l*vm install.log /i edm_3.0.1_x86_64.msi EDMAPPDIR=`"c:\Program Files\edm`" ALLUSERS=1

or using cmd.exe::

  msiexec.exe /qr /l*vm install.log /i edm_3.0.1_x86_64.msi EDMAPPDIR="c:\Program Files\edm" ALLUSERS=1

The above commands will attempt a ``per-machine`` install of edm in the
``c:\Program Files\edm`` folder.

.. warning::

  A ``per-machine`` install will fail if the installer is started without
  administrator privileges.


macOS
-----

To install EDM using the ``pkg`` installer please follow the these steps:

- Locate the pkg installer file in the Finder.
- Right-click on the pkg installer.
- Select ``Open``.
- When the popup dialog appears select ``Open`` to continue.

To install EDM using the ``.sh`` installer open a terminal
console window and run

::

 $ sh edm_cli_3.0.1_osx_x86_64.sh

Follow the directions in the console.

.. warning::

   - We do *not* recommend that most Mac users install using the ``.sh`` 
     installer, because it does not integrate well with the Enthought
     Tools for Visual Studio Code.

.. note::

   - Using the macOS ``.sh`` installer, the user can control
     the path to install the EDM application.



.. _`EDM application distribution bundles`: https://docs.enthought.com/edm/user/cli.html#edm-applications
.. _`EDM GUI frontend documentation`: https://docs.enthought.com/edm-gui-2/