source: cssboy_deployment/docs/source/install.rst @ 1062

.. $Id: install.rst 1062 2012-08-06 21:14:17Z jemian $

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

The steps to install CSS-BOY will be described here.  
Basically, you need Java (at minimum is a Java Runtime Environment, or JRE)
to run CSS-BOY and you need EPICS IOCs to provide
Process Variables to access controls.  APS beam lines will need the screens
from synApps.

Prerequisites
=============

.. index:: EPICS; IOC
.. index:: EPICS; PV

* You need a Java Runtime Environment (at least) to run CSS.
* You will need one or more EPICS IOCs (input-output controllers) 
        to serve EPICS PVs (process variables)
        or else all you can do with CSS-BOY is to use the simulator inside CSS.
* You must have a network connection to communicate with EPICS PVs
* You should run the EPICS ``caRepeater`` on the local workstation 
        to route PV connections to your CSS-BOY session.


:index:`CSS-BOY`
================

#. Visit this URL and download the most-recent version of 
   CSS-BOY **Basic EPICS** for your OS and architecture:
   http://ics-web.sns.ornl.gov/css/products.html
   
   (To access unadvertised builds, visit this alternative 
   URL: https://ics-web.sns.ornl.gov/css/updates/apps/ )

#. Unzip the contents someplace.  Typical for me is:
   ``~/Apps/CSS_EPICS_3.1.1``

        .. tip:: Use the SNS release of CSS-BOY
                
                For a short time, APS developed a custom CSS product [#aps_css]_ to provide
                features and customizations that were not part of the SNS build.
                
                It is recommended now to use the CSS-BOY as built by the team at
                SNS [#css_boy_downloads]_.

#. CSS-BOY is now ready to run from the installation directory.  
        Look for the ``css`` executable.

:index:`subclipse`
====================

.. warning::  This section needs to be worked out.

..
        some users want to use this with CSS-BOY
        
        http://subclipse.tigris.org/updates  /...
        
        Problems with getting the architecture and versions and other stuff just right
        
        Mac user still has problems.  Java-hl support.  Start with svn v1.6 and get both java tools, then upgrade "and pick the other tool." ...
        
        Mac users of Apple Firewall will be annoyed by a recurrent prompt.

:index:`synApps`
================

Getting the synApps OPI screens from some place
-----------------------------------------------------

To get the synApps OPI screens, you need to do one of the following 
(subject to revision):

#. import synApps project from /APSshare (for APS beam lines)
        path:   /APSshare/epics/synApps_5_6/support/all_opi


#. checkout synApps development trunk from SVN, then import as project
        There is a linux shell script to do the checkout::

                https://subversion.xor.aps.anl.gov/synApps/support/trunk/checkout.csh 
        
        One way is to place this file in */usr/local/epics* and then run it.
        It will create a directory called *synAppsSVN/support* that contains
        the development trunk.


#. checkout a snapshot of the 
        synApps OPI screens::

                svn co https://subversion.xray.aps.anl.gov/bcdaext/cssboy_deployment/all_opi/ ./all_opi
        
        .. caution::
                Note that this subversion repository is a copy from the synApps development trunk 
                on a certain date and may not contain the most recent modifications!




---------------------------------------

.. rubric:: Footnotes

.. [#css_boy_downloads] http://ics-web.sns.ornl.gov/css/products.html
.. [#aps_css] http://css.aps.anl.gov
.. [#synApps] Software for control of an APS beam line:  http://www.aps.anl.gov/bcda/synApps