{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "47b5fdea",
   "metadata": {},
   "source": [
    "# Installation"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "7b0befd5",
   "metadata": {},
   "source": [
    "``tttrlib`` can either be installed from prebuilt binaries or from the source code.\n",
    "For most users it is recommended to install ``tttrlib`` using the prebuilt binaries.\n",
    "Below the installation using prebuilt binaries and the prerequisites to compile\n",
    "``tttrlib`` are briefly outlined.\n",
    "\n",
    "\n",
    "Prebuilt binaries\n",
    "=================\n",
    "It is recommended to install ``tttrlib`` for Python environments via ``conda`` by.\n",
    "\n",
    "```\n",
    "conda install -c tpeulen tttrlib\n",
    "```\n",
    "\n",
    "Alternatively, ``tttrlib`` can be installed via ``pip``.\n",
    "\n",
    "```\n",
    "pip install tttrlib\n",
    "```\n",
    "\n",
    "\n",
    "Compilation\n",
    "===========\n",
    "\n",
    "``tttrlib`` can be compiled and installed using the source code provided in the\n",
    "git repository. ``tttrlib`` is compiled in Docker environments. The continuous \n",
    "integration pipeline can be used as a reference to setup a compilation machine\n",
    "\n",
    "\n",
    "```\n",
    "git clone --recursive https://github.com/fluorescence-tools/tttrlib.git\n",
    "cd tttrlib\n",
    "python setup.py install\n",
    "```\n",
    "\n",
    "\n",
    "To compile ``tttrlib`` a set of prerequisites need to be fulfilled:\n",
    "\n",
    "    1. An installed compiler.\n",
    "    2. The `HDF5 <https://www.hdfgroup.org/>`_ library with C/C++ include files.\n",
    "    3. A recent 64bit `Python <https://www.python.org/>`_ installation with include files.\n",
    "    4. `cmake <https://cmake.org/>`_\n",
    "    5. `SWIG <http://www.swig.org/>`_\n",
    "\n",
    "To debug and analyze the ouput of ``tttrlib`` in more detail it can be useful to\n",
    "build the library in Debug mode that outputs additional information to the standard\n",
    "standard logging stream. tttrlib can be build in debugging mode by.\n",
    "\n",
    "\n",
    "```\n",
    "python setup.py build_ext --debug\n",
    "```\n",
    "\n",
    "Windows\n",
    "-------\n",
    "On windows ``tttrlib`` is best compiled with the `Visual Studio 2017 <https://visualstudio.microsoft.com/>`_. For\n",
    "compilation the Visual Studion Community edition is sufficient. In addition to\n",
    "Visual Studio the libraries and the include files as listed above need to be\n",
    "installed. The prebuilt binaries are compiled on Windows 10 with using 64bit anaconda\n",
    "Python environments `miniconda <https://docs.conda.io/en/latest/miniconda.html>`_\n",
    "using the conda build recipe that is provided with the source code in the ``conda-recipe``\n",
    "folder.\n",
    "\n",
    "macOS\n",
    "-----\n",
    "For MacOS the prebuilt binaries are compiled on MacOS 10.13 with the Apple clang\n",
    "compiler using a anaconda distribution and the provided ``conda-recipe``.\n",
    "\n",
    "Linux\n",
    "-----\n",
    "The Linux prebuilt binaries are compiled on Ubuntu 18.04 in an anaconda distribution\n",
    "and the provided ``conda-recipe``.\n",
    "\n",
    "Conda\n",
    "-----\n",
    "\n",
    "A conda recipe is provided in the folder 'conda-recipe' to build the tttrlib library with the\n",
    "`conda build <https://docs.conda.io/projects/conda-build/en/latest/>`_ environment.\n",
    "\n",
    "```\n",
    "conda install conda-build\n",
    "conda build build-tools/conda-recipe\n",
    "```\n",
    "\n",
    "To build the library download the recipe, install the conda build package and use\n",
    "the provided recipe to build the library."
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.15"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}