INSTALL.rst

ATIP Installation

This guide is for Linux and is based on the current structures of AT and Pytac, if you find a mistake anywhere in ATIP please raise an issue on ATIP's GitHub page, here.

Initial Setup and Installation

Option 1: Install ATIP using pip:

$ pip install atip

Option 2: Install ATIP from GitHub:

1. Clone ATIP:

   $ cd <source-directory>
   $ git clone https://github.com/DiamondLightSource/atip.git
   

2. Create a pipenv and install the dependencies:

   $ cd atip
   $ pipenv install --dev
   $ pipenv shell
   

3. Run the tests to ensure everything is working correctly:

   $ python -m pytest
   

Troubleshooting

Please note that for ATIP to function with Python 3.7 or later, you must use Cothread>=2.16.