.. ESCAPE documentation master file, created by
   sphinx-quickstart on Sat Mar 11 22:01:46 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


License
----------

ESCAPE is a free for non-commercial usage python package and framework for creating applications for simulating and fitting of X-ray and neutron scattering data.
The software is closed-source and is distributed under the `ESCAPE End-User License Agreement (EULA) <eula.html>`_.
By downloading, installing, or using the Software, you agree to the terms of the EULA.


Installation
-------------

.. raw:: html

   <div style="border:1px solid #ccc; padding:1.2em; border-radius:6px; margin:1em 0;">
     <p>ESCAPE is free for non-commercial use only.
        Commercial use requires a <a href="eula.html#grant-of-license">separate license</a>.</p>
     <label style="cursor:pointer;">
       <input type="checkbox" id="eula-agree">
       I have read and agree to the
       <a href="eula.html" target="_blank">End-User License Agreement (EULA)</a>.
     </label>
     <br><br>
     <a id="download-btn" href="_static/download"
        style="pointer-events:none; opacity:0.4; padding:0.5em 1.5em;
               background:#007bff; color:#fff; border-radius:4px;
               text-decoration:none; display:inline-block;">
       Download ESCAPE
     </a>
   </div>

   <script>
   document.getElementById('eula-agree').addEventListener('change', function() {
     var btn = document.getElementById('download-btn');
     btn.style.pointerEvents = this.checked ? 'auto' : 'none';
     btn.style.opacity = this.checked ? '1' : '0.4';
   });
   </script>

Choose an appropriate wheel file
according to your operating system and installed Python version you have.
For example, wheel *ESCAPE-0.8.0.dev0-7598-cp35-cp35m-linux_x86_64.whl* is for 
64 bit linux and Python version 3.5.

After downloading wheel run the following command in the shell, (use *sudo* under linux if necessary)::

    pip3 install -U /path/to/your/wheel_file.whl


This command will install a version with minimal dependencies. It is useful if you are going to use
Python only. If you plan to use Jupyter notebooks, please run the following command after installation::

    pip3 install -U /path/to/your/wheel_file.whl[jupyter]

This command will install extra dependencies.


.. note::

    In the case if you have error messages like "DLL load failed" when importing ESCAPE package in your python code under Windows, 
    please install `Visual Studio 2017 redistributable <https://aka.ms/vs/16/release/vc_redist.x64.exe>`_.