This document covers installation of xal for typical usage. If you want to setup a development environment, see Contributor guide documentation.
xal is free software. See License for details.
xal requires Python version 2.7. Other versions may work, but they are not part of the test suite at the moment.
pip install xal[local,ssh]
If you don’t need all types of sessions, you can install only a subset of
xal‘s dependencies, i.e. run either
pip install xal[local] or
pip install xal[ssh].
As a library¶
In order to use xal as a dependency of another project, you should add
xal[local,ssh] to the requirements of your main project. Typically in
from setuptools import setup setup( install_requires=[ 'xal[local,ssh]', #... ] # ... )
If you don’t need all types of sessions, you can require only a subset of
xal‘s dependencies, i.e. declare either