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

Last change on this file since 1123 was 1123, checked in by ehanson, 10 years ago

Updated documentation with opisys info

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision URL
File size: 3.8 KB
Line 
1.. $Id: install.rst 1123 2012-10-01 15:34:46Z ehanson $
2
3============
4Installation
5============
6
7The steps to install CSS-BOY will be described here. 
8Basically, you need Java (at minimum is a Java Runtime Environment, or JRE)
9to run CSS-BOY and you need EPICS IOCs to provide
10Process Variables to access controls.  APS beam lines will need the screens
11from synApps.
12
13Prerequisites
14=============
15
16.. index:: EPICS; IOC
17.. index:: EPICS; PV
18
19* You need a Java Runtime Environment (at least) to run CSS.
20* You will need one or more EPICS IOCs (input-output controllers)
21        to serve EPICS PVs (process variables)
22        or else all you can do with CSS-BOY is to use the simulator inside CSS.
23* You must have a network connection to communicate with EPICS PVs
24* You should run the EPICS ``caRepeater`` on the local workstation
25        to route PV connections to your CSS-BOY session.
26
27
28:index:`CSS-BOY`
29================
30
31#. Visit this URL and download the most-recent version of
32   CSS-BOY **Basic EPICS** for your OS and architecture:
33   http://ics-web.sns.ornl.gov/css/products.html
34   
35   (To access unadvertised builds, visit this alternative
36   URL: https://ics-web.sns.ornl.gov/css/updates/apps/ )
37
38#. Unzip the contents someplace.  Typical for me is:
39   ``~/Apps/CSS_EPICS_3.1.1``
40
41        .. tip:: Use the SNS release of CSS-BOY
42               
43                For a short time, APS developed a custom CSS product [#aps_css]_ to provide
44                features and customizations that were not part of the SNS build.
45               
46                It is recommended now to use the CSS-BOY as built by the team at
47                SNS [#css_boy_downloads]_.
48
49#. CSS-BOY is now ready to run from the installation directory. 
50        Look for the ``css`` executable.
51
52:index:`subclipse`
53====================
54
55.. warning::  This section needs to be worked out.
56
57..
58        some users want to use this with CSS-BOY
59       
60        http://subclipse.tigris.org/updates  /...
61       
62        Problems with getting the architecture and versions and other stuff just right
63       
64        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." ...
65       
66        Mac users of Apple Firewall will be annoyed by a recurrent prompt.
67
68:index:`synApps`
69================
70
71Getting the synApps OPI screens from some place
72-----------------------------------------------------
73
74To get the synApps OPI screens, you need to do one of the following
75(subject to revision):
76
77#. import synApps project from /APSshare (for APS beam lines)
78        path:   /APSshare/epics/synApps_5_6/support/all_opi
79
80
81#. checkout synApps development trunk from SVN, then import as project
82        There is a linux shell script to do the checkout::
83
84                https://subversion.xor.aps.anl.gov/synApps/support/trunk/checkout.csh
85       
86        One way is to place this file in */usr/local/epics* and then run it.
87        It will create a directory called *synAppsSVN/support* that contains
88        the development trunk.
89
90
91#. checkout a snapshot of the
92        synApps OPI screens::
93
94                svn co https://subversion.xray.aps.anl.gov/bcdaext/cssboy_deployment/all_opi/ ./all_opi
95       
96        .. caution::
97                Note that this subversion repository is a copy from the synApps development trunk
98                on a certain date and may not contain the most recent modifications!
99
100:index:`APS System` Screens (opisys)
101===========================
102
103#. Checkout a snapshot of the screens::
104
105                svn co https://subversion.xray.aps.anl.gov/bcdaext/cssboy_deployment/opisys/ ./opisys
106
107#. Make the script generated screens
108
109        Because there are so many screens (over 4000), many are generated by scripts.
110        To generate these, enter the ``opisys/sr/`` directory and run ``make``.
111       
112        .. caution::
113                Again, Note that these are separate from the development trunk and may
114                not contain the latest updates!
115
116
117---------------------------------------
118
119.. rubric:: Footnotes
120
121.. [#css_boy_downloads] http://ics-web.sns.ornl.gov/css/products.html
122.. [#aps_css] http://css.aps.anl.gov
123.. [#synApps] Software for control of an APS beam line:  http://www.aps.anl.gov/bcda/synApps
Note: See TracBrowser for help on using the repository browser.