source: cssboy_deployment/docs/build/html/instructions.html @ 870

Last change on this file since 870 was 870, checked in by jemian, 10 years ago

partial, need to test and finish documentation

  • Property svn:mime-type set to text/html
File size: 16.2 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>Instructions &mdash; cssboydeployment 1 documentation</title>
12   
13    <link rel="stylesheet" href="_static/agogo.css" type="text/css" />
14    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '',
19        VERSION:     '1',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="_static/jquery.js"></script>
26    <script type="text/javascript" src="_static/underscore.js"></script>
27    <script type="text/javascript" src="_static/doctools.js"></script>
28    <link rel="top" title="cssboydeployment 1 documentation" href="index.html" />
29    <link rel="prev" title="Plans" href="plans.html" /> 
30  </head>
31  <body>
32    <div class="header-wrapper">
33      <div class="header">
34        <div class="headertitle"><a
35          href="index.html">cssboydeployment 1 documentation</a></div>
36        <div class="rel">
37          <a href="plans.html" title="Plans"
38             accesskey="P">previous</a> |
39          <a href="genindex.html" title="General Index"
40             accesskey="I">index</a>
41        </div>
42       </div>
43    </div>
44
45    <div class="content-wrapper">
46      <div class="content">
47        <div class="document">
48           
49      <div class="documentwrapper">
50        <div class="bodywrapper">
51          <div class="body">
52           
53  <div class="section" id="instructions">
54<h1>Instructions<a class="headerlink" href="#instructions" title="Permalink to this headline">¶</a></h1>
55<p>Install OPI screens (and other resources such as image files, javascript,
56or definition files) into projects within your workspace.  The OPI screens
57from <em>synApps</em> <a class="footnote-reference" href="#synapps" id="id1">[5]</a> will go into their own project within your
58workspace.  The screens from the APS accelerator will go into another
59project.  Your instrument and beam line screens will typically go into
60a single project but it is possible that you might have separate projects
61for upstream optics, beam line staff, and users.</p>
62<blockquote>
63<div><p>Each <em>project</em> within CSS may come from a separate location:</p>
64<ul class="simple">
65<li>local directory within your account and CSS workspace</li>
66<li>file server accessible from your directory space</li>
67<li>NFS or SMB (Samba) file server</li>
68<li>Version Control working directory</li>
69</ul>
70<p>You can&#8217;t share the CSS Workspace with another user,
71even if that other user is logged in with the same name.
72This will likely cause abnormal behavior for CSS.
73<strong>But</strong>, you can import a common or shared directory into your CSS
74workspace.</p>
75</div></blockquote>
76<p>Leave the <tt class="docutils literal"><span class="pre">CSS</span></tt> project for use as a sandbox (special area for files
77which you are testing or using for a short time and do not wish to treat
78as part of everyone&#8217;s workspace).</p>
79<div class="section" id="install-css-boy-on-your-computer">
80<h2>Install CSS-BOY on your computer<a class="headerlink" href="#install-css-boy-on-your-computer" title="Permalink to this headline">¶</a></h2>
81<p>CSS <a class="footnote-reference" href="#css" id="id2">[3]</a> (Control System Studio) was designed at DESY, Hamburg, Germany.
82CSS is software that provides a rich
83environment for EPICS controls.</p>
84<p>The SNS at ORNL added the BOY (Best Opi Yet &#8211;
85where OPI is an EPICS term Operator Programmer Interface)
86component which is an EPICS display tool.
87For some time, APS developed a custom CSS product <a class="footnote-reference" href="#aps-css" id="id3">[4]</a> to provide
88features and customizations that were not part of the SNS build.</p>
89<p>It is recommended now to use the CSS-BOY as built by the team at
90SNS <a class="footnote-reference" href="#css-boy-downloads" id="id4">[2]</a>.</p>
91<div class="admonition note">
92<p class="first admonition-title">Note</p>
93<p class="last">You need a Java Runtime Environment (at least) to run CSS.
94Also, you will need one or more EPICS IOCs to serve PVs
95or all you can do is use the simulator inside CSS.</p>
96</div>
97<ol class="arabic simple">
98<li>Visit this URL and download most-recent version of
99<strong>Basic EPICS</strong> for your OS:
100<a class="reference external" href="http://ics-web.sns.ornl.gov/css/products.html">http://ics-web.sns.ornl.gov/css/products.html</a></li>
101<li>Unzip the contents someplace.  Typical for me is:
102<tt class="docutils literal"><span class="pre">~/Apps/CSS_EPICS_3.1.0</span></tt></li>
103</ol>
104</div>
105<div class="section" id="add-opi-screens-from-synapps-as-a-css-project">
106<h2>add OPI screens from synApps as a CSS project<a class="headerlink" href="#add-opi-screens-from-synapps-as-a-css-project" title="Permalink to this headline">¶</a></h2>
107<ol class="arabic simple">
108<li>Open the <tt class="docutils literal"><span class="pre">CSS_EPICS_3.1.0</span></tt> (or whatever version) directory</li>
109<li>Start <tt class="docutils literal"><span class="pre">css</span></tt> by double-clicking it</li>
110<li>Select menu <tt class="docutils literal"><span class="pre">File--&gt;Import</span> <span class="pre">...</span></tt></li>
111<li>Open <tt class="docutils literal"><span class="pre">General</span></tt> category,
112select <tt class="docutils literal"><span class="pre">Existing</span> <span class="pre">Projects</span> <span class="pre">into</span> <span class="pre">Workspace</span></tt>,
113click <tt class="docutils literal"><span class="pre">Next</span></tt> button</li>
114<li>Click <tt class="docutils literal"><span class="pre">Browse</span> <span class="pre">...</span></tt> button (in <em>Import</em> window),
115navigate to <tt class="docutils literal"><span class="pre">/APSshare/epics/synApps_5_6/support/all_opi</span></tt>,
116click <tt class="docutils literal"><span class="pre">Ok</span></tt> button</li>
117<li>Click <tt class="docutils literal"><span class="pre">Finish</span></tt> button (in <em>Import</em> window)</li>
118</ol>
119</div>
120<div class="section" id="define-synapps-default-fonts-and-colors">
121<h2>define synApps default fonts and colors<a class="headerlink" href="#define-synapps-default-fonts-and-colors" title="Permalink to this headline">¶</a></h2>
122<ol class="arabic simple">
123<li>Select menu <tt class="docutils literal"><span class="pre">Edit--&gt;Preferences</span> <span class="pre">...</span></tt></li>
124<li>Open item <tt class="docutils literal"><span class="pre">CSS</span> <span class="pre">Applications</span></tt></li>
125<li>Open item <tt class="docutils literal"><span class="pre">Display</span></tt></li>
126<li>Click on item <tt class="docutils literal"><span class="pre">BOY</span></tt></li>
127<li>For Color File, replace text with <tt class="docutils literal"><span class="pre">/synApps/color.def</span></tt> or <em>Browse...</em> to it</li>
128<li>For Font File, replace text with <tt class="docutils literal"><span class="pre">/synApps/font.def</span></tt> or <em>Browse...</em> to it</li>
129<li>For Top OPIs, replace with OPI file of your choice</li>
130</ol>
131<div class="admonition note">
132<p class="first admonition-title">Note</p>
133<p>If get a console message that says:</p>
134<blockquote>
135<div>2012-04-30 15:59:12 ERROR: Failed to read font definition file.</div></blockquote>
136<p class="last">then you&#8217;ve got a typo or some other error.  Repeat these steps to fix it.</p>
137</div>
138</div>
139<div class="section" id="define-a-project-for-your-epics-installation">
140<h2>Define a project for your EPICS installation<a class="headerlink" href="#define-a-project-for-your-epics-installation" title="Permalink to this headline">¶</a></h2>
141<p>Screens for your instrument or beam line or other installation of EPICS
142may already be available.  If so, you might import them by following the steps
143above used to import synApps.  If you need to develop your own screens,
144then follow these steps:</p>
145<ol class="arabic simple">
146<li>Select menu <tt class="docutils literal"><span class="pre">File--&gt;New</span></tt></li>
147<li>Open <tt class="docutils literal"><span class="pre">General</span></tt> category,
148select <tt class="docutils literal"><span class="pre">Project</span></tt>,
149click <tt class="docutils literal"><span class="pre">Next</span></tt> button</li>
150<li>Give it a Project name, something short such as <em>44ID</em> or <em>iocPRJ</em>
151(try to avoid using spaces, it makes things harder later on),</li>
152<li>In the <tt class="docutils literal"><span class="pre">Navigator</span></tt> view,
153open the new project by double-clicking (or any other equivalent way)</li>
154</ol>
155<div class="section" id="create-an-opi-file">
156<h3>Create an OPI file<a class="headerlink" href="#create-an-opi-file" title="Permalink to this headline">¶</a></h3>
157<ol class="arabic simple">
158<li>Select menu <tt class="docutils literal"><span class="pre">File--&gt;New</span></tt></li>
159<li>Open <tt class="docutils literal"><span class="pre">BOY</span></tt> category,
160select <tt class="docutils literal"><span class="pre">OPI</span> <span class="pre">File</span></tt>,
161click <tt class="docutils literal"><span class="pre">Next</span></tt> button</li>
162<li>Select the folder to contain your new OPI screen,
163type the name of the new OPI file in the box,
164click <tt class="docutils literal"><span class="pre">Finish</span></tt> button</li>
165</ol>
166<p>Your new screen will appear in a CSS-BOY editing window.
167You might consider changing to the <tt class="docutils literal"><span class="pre">OPI</span> <span class="pre">Editor</span></tt> perspective
168as this will provide much more help in editing the screen.</p>
169<p>Once you have setup the CSS-BOY project for your EPICS installation,
170you might want one particular file to be the default  <em>main</em> file
171for your CSS-BOY workspace.  Edit the menu for <em>Top OPIs</em> via:
172<tt class="docutils literal"><span class="pre">Edit</span> <span class="pre">--&gt;</span> <span class="pre">Preferences</span> <span class="pre">...</span> <span class="pre">--&gt;</span> <span class="pre">CSS</span> <span class="pre">Applications</span> <span class="pre">--&gt;</span> <span class="pre">Display</span></tt></p>
173<div class="section" id="definitions">
174<h4>Definitions<a class="headerlink" href="#definitions" title="Permalink to this headline">¶</a></h4>
175<p>Some of the terms used by eclipse and CSS and CSS-BOY may be unfamiliar.</p>
176<table border="1" class="docutils">
177<colgroup>
178<col width="15%" />
179<col width="85%" />
180</colgroup>
181<thead valign="bottom">
182<tr class="row-odd"><th class="head">term</th>
183<th class="head">&nbsp;</th>
184</tr>
185</thead>
186<tbody valign="top">
187<tr class="row-even"><td>Workspace</td>
188<td>file system directory containing directories
189and files used by a single CSS-BOY user</td>
190</tr>
191<tr class="row-odd"><td>Project</td>
192<td>subdirectory within a <tt class="docutils literal"><span class="pre">workspace</span></tt> containing
193related files and subdirectories</td>
194</tr>
195<tr class="row-even"><td><tt class="docutils literal"><span class="pre">.js</span></tt></td>
196<td>javascript file</td>
197</tr>
198<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">.opi</span></tt></td>
199<td>display screen file used by CSS-BOY</td>
200</tr>
201<tr class="row-even"><td>Perspective</td>
202<td>Defined arrangement of Views and Editors in eclipse.
203A Perspective can be customized and saved within
204the Workspace for later recall.</td>
205</tr>
206<tr class="row-odd"><td>View</td>
207<td>One type of display in eclipse, some can be undocked
208(or torn-off) so they can be a spearate window.
209??? Are undocked Views saved as part of the
210Perspective? ???</td>
211</tr>
212<tr class="row-even"><td>Editor</td>
213<td>One type of display in eclipse.</td>
214</tr>
215<tr class="row-odd"><td>Navigator</td>
216<td>Used to browse the Workspace for files and subdirectories.</td>
217</tr>
218<tr class="row-even"><td>eclipse</td>
219<td>Java-based software providing a configurable interactive
220development environment (IDE).  Eclipse can be highly
221customized to deliver a specific application,
222such as CSS or CSS-BOY.</td>
223</tr>
224<tr class="row-odd"><td>CSS</td>
225<td>Control System Studio from DESY, based on eclipse</td>
226</tr>
227<tr class="row-even"><td>CSS-BOY</td>
228<td>CSS Best Opi Yet EPICS Display software (replacement for medm)</td>
229</tr>
230</tbody>
231</table>
232</div>
233<div class="section" id="footnotes">
234<h4>Footnotes<a class="headerlink" href="#footnotes" title="Permalink to this headline">¶</a></h4>
235<table class="docutils footnote" frame="void" id="eclipse" rules="none">
236<colgroup><col class="label" /><col /></colgroup>
237<tbody valign="top">
238<tr><td class="label">[1]</td><td><a class="reference external" href="http://eclipse.org">http://eclipse.org</a></td></tr>
239</tbody>
240</table>
241<table class="docutils footnote" frame="void" id="css-boy-downloads" rules="none">
242<colgroup><col class="label" /><col /></colgroup>
243<tbody valign="top">
244<tr><td class="label"><a class="fn-backref" href="#id4">[2]</a></td><td><a class="reference external" href="http://ics-web.sns.ornl.gov/css/products.html">http://ics-web.sns.ornl.gov/css/products.html</a></td></tr>
245</tbody>
246</table>
247<table class="docutils footnote" frame="void" id="css" rules="none">
248<colgroup><col class="label" /><col /></colgroup>
249<tbody valign="top">
250<tr><td class="label"><a class="fn-backref" href="#id2">[3]</a></td><td><a class="reference external" href="http://css.desy.de">http://css.desy.de</a></td></tr>
251</tbody>
252</table>
253<table class="docutils footnote" frame="void" id="aps-css" rules="none">
254<colgroup><col class="label" /><col /></colgroup>
255<tbody valign="top">
256<tr><td class="label"><a class="fn-backref" href="#id3">[4]</a></td><td><a class="reference external" href="http://css.aps.anl.gov">http://css.aps.anl.gov</a></td></tr>
257</tbody>
258</table>
259<table class="docutils footnote" frame="void" id="synapps" rules="none">
260<colgroup><col class="label" /><col /></colgroup>
261<tbody valign="top">
262<tr><td class="label"><a class="fn-backref" href="#id1">[5]</a></td><td><a class="reference external" href="http://www.aps.anl.gov/bcda/synApps">http://www.aps.anl.gov/bcda/synApps</a></td></tr>
263</tbody>
264</table>
265</div>
266</div>
267</div>
268</div>
269
270
271          </div>
272        </div>
273      </div>
274        </div>
275        <div class="sidebar">
276          <h3>Table Of Contents</h3>
277          <ul class="current">
278<li class="toctree-l1"><a class="reference internal" href="plans.html">Plans</a></li>
279<li class="toctree-l1 current"><a class="current reference internal" href="">Instructions</a><ul>
280<li class="toctree-l2"><a class="reference internal" href="#install-css-boy-on-your-computer">Install CSS-BOY on your computer</a></li>
281<li class="toctree-l2"><a class="reference internal" href="#add-opi-screens-from-synapps-as-a-css-project">add OPI screens from synApps as a CSS project</a></li>
282<li class="toctree-l2"><a class="reference internal" href="#define-synapps-default-fonts-and-colors">define synApps default fonts and colors</a></li>
283<li class="toctree-l2"><a class="reference internal" href="#define-a-project-for-your-epics-installation">Define a project for your EPICS installation</a></li>
284</ul>
285</li>
286</ul>
287
288          <h3 style="margin-top: 1.5em;">Search</h3>
289          <form class="search" action="search.html" method="get">
290            <input type="text" name="q" />
291            <input type="submit" value="Go" />
292            <input type="hidden" name="check_keywords" value="yes" />
293            <input type="hidden" name="area" value="default" />
294          </form>
295          <p class="searchtip" style="font-size: 90%">
296            Enter search terms or a module, class or function name.
297          </p>
298        </div>
299        <div class="clearer"></div>
300      </div>
301    </div>
302
303    <div class="footer-wrapper">
304      <div class="footer">
305        <div class="left">
306          <a href="plans.html" title="Plans"
307             >previous</a> |
308          <a href="genindex.html" title="General Index"
309             >index</a>
310            <br/>
311            <a href="_sources/instructions.txt"
312               rel="nofollow">Show Source</a>
313        </div>
314
315        <div class="right">
316         
317    <div class="footer">
318        &copy; Copyright 2012, Pete Jemian.
319      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
320    </div>
321        </div>
322        <div class="clearer"></div>
323      </div>
324    </div>
325
326  </body>
327</html>
Note: See TracBrowser for help on using the repository browser.