source: cssboy_deployment/docs/build/html/_sources/instructions.txt @ 853

Last change on this file since 853 was 853, checked in by jemian, 11 years ago

documentation

  • Property svn:eol-style set to native
File size: 6.4 KB
Line 
1.. $Id: instructions.rst 848 2012-04-30 22:16:57Z jemian $
2
3==========================
4Instructions
5==========================
6
7Install OPI screens (and other resources such as image files, javascript,
8or definition files) into projects within your workspace.  The OPI screens
9from *synApps* [#synApps]_ will go into their own project within your
10workspace.  The screens from the APS accelerator will go into another
11project.  Your instrument and beam line screens will typically go into
12a single project but it is possible that you might have separate projects
13for upstream optics, beam line staff, and users.
14
15  Each *project* within CSS may come from a separate location:
16 
17  * local directory within your account and CSS workspace
18  * file server accessible from your directory space
19  * NFS or SMB (Samba) file server
20  * Version Control working directory
21 
22  You can't share the CSS Workspace with another user,
23  even if that other user is logged in with the same name.
24  This will likely cause abnormal behavior for CSS.
25  **But**, you can import a common or shared directory into your CSS
26  workspace.
27
28Leave the ``CSS`` project for use as a sandbox (special area for files
29which you are testing or using for a short time and do not wish to treat
30as part of everyone's workspace).
31
32
33Install CSS-BOY on your computer
34++++++++++++++++++++++++++++++++
35
36CSS [#CSS]_ (Control System Studio) was designed at DESY, Hamburg, Germany. 
37CSS is software that provides a rich
38environment for EPICS controls.
39
40The SNS at ORNL added the BOY (Best Opi Yet --
41where OPI is an EPICS term Operator Programmer Interface)
42component which is an EPICS display tool.
43For some time, APS developed a custom CSS product [#aps_css]_ to provide
44features and customizations that were not part of the SNS build.
45
46It is recommended now to use the CSS-BOY as built by the team at
47SNS [#css_boy_downloads]_.
48
49.. note::
50   You need a Java Runtime Environment (at least) to run CSS.
51   Also, you will need one or more EPICS IOCs to serve PVs
52   or all you can do is use the simulator inside CSS.
53
54#. Visit this URL and download most-recent version of
55   **Basic EPICS** for your OS:
56   http://ics-web.sns.ornl.gov/css/products.html
57#. Unzip the contents someplace.  Typical for me is:
58   ``~/Apps/CSS_EPICS_3.1.0``
59
60
61add OPI screens from synApps as a CSS project
62+++++++++++++++++++++++++++++++++++++++++++++
63
64#. Open the ``CSS_EPICS_3.1.0`` (or whatever version) directory
65#. Start ``css`` by double-clicking it
66#. Select menu ``File-->Import ...``
67#. Open ``General`` category,
68   select ``Existing Projects into Workspace``,
69   click ``Next`` button
70#. Click ``Browse ...`` button (in *Import* window),
71   navigate to ``/APSshare/epics/synApps_5_6/support/all_opi``,
72   click ``Ok`` button
73#. Click ``Finish`` button (in *Import* window)
74
75define synApps default fonts and colors
76+++++++++++++++++++++++++++++++++++++++++++++
77
78#. Select menu ``Edit-->Preferences ...``
79#. Open item ``CSS Applications``
80#. Open item ``Display``
81#. Click on item ``BOY``
82#. For Color File, replace text with ``/synApps/color.def`` or *Browse...* to it
83#. For Font File, replace text with ``/synApps/font.def`` or *Browse...* to it
84#. For Top OPIs, replace with OPI file of your choice
85
86.. note:: If get a console message that says:
87
88      2012-04-30 15:59:12 ERROR: Failed to read font definition file.
89
90   then you've got a typo or some other error.  Repeat these steps to fix it.
91
92
93Define a project for your EPICS installation
94+++++++++++++++++++++++++++++++++++++++++++++
95
96Screens for your instrument or beam line or other installation of EPICS
97may already be available.  If so, you might import them by following the steps
98above used to import synApps.  If you need to develop your own screens,
99then follow these steps:
100
101#. Select menu ``File-->New``
102#. Open ``General`` category,
103   select ``Project``,
104   click ``Next`` button
105#. Give it a Project name, something short such as *44ID* or *iocPRJ*
106   (try to avoid using spaces, it makes things harder later on),
107#. In the ``Navigator`` view,
108   open the new project by double-clicking (or any other equivalent way)
109
110Create an OPI file
111******************
112
113#. Select menu ``File-->New``
114#. Open ``BOY`` category,
115   select ``OPI File``,
116   click ``Next`` button
117#. Select the folder to contain your new OPI screen,
118   type the name of the new OPI file in the box,
119   click ``Finish`` button
120
121Your new screen will appear in a CSS-BOY editing window.
122You might consider changing to the ``OPI Editor`` perspective
123as this will provide much more help in editing the screen.
124
125Once you have setup the CSS-BOY project for your EPICS installation,
126you might want one particular file to be the default  *main* file
127for your CSS-BOY workspace.  Edit the menu for *Top OPIs* via:
128``Edit --> Preferences ... --> CSS Applications --> Display``
129
130
131Definitions
132-----------
133
134Some of the terms used by eclipse and CSS and CSS-BOY may be unfamiliar.
135
136============  ==================================================================
137term
138============  ==================================================================
139Workspace     file system directory containing directories
140              and files used by a single CSS-BOY user
141Project       subdirectory within a ``workspace`` containing
142              related files and subdirectories
143``.js``       javascript file
144``.opi``      display screen file used by CSS-BOY
145Perspective   Defined arrangement of Views and Editors in eclipse.
146              A Perspective can be customized and saved within
147              the Workspace for later recall.
148View          One type of display in eclipse, some can be undocked
149              (or torn-off) so they can be a spearate window.
150              ??? Are undocked Views saved as part of the
151              Perspective? ???
152Editor        One type of display in eclipse.
153Navigator     Used to browse the Workspace for files and subdirectories.
154eclipse       Java-based software providing a configurable interactive
155              development environment (IDE).  Eclipse can be highly
156              customized to deliver a specific application,
157              such as CSS or CSS-BOY.
158CSS           Control System Studio from DESY, based on eclipse
159CSS-BOY       CSS Best Opi Yet EPICS Display software (replacement for medm)
160============  ==================================================================
161
162Footnotes
163---------
164
165.. [#eclipse]           http://eclipse.org
166.. [#css_boy_downloads] http://ics-web.sns.ornl.gov/css/products.html
167.. [#css]               http://css.desy.de
168.. [#aps_css]           http://css.aps.anl.gov
169.. [#synApps]           http://www.aps.anl.gov/bcda/synApps
Note: See TracBrowser for help on using the repository browser.