Changeset 1051


Ignore:
Timestamp:
Jul 18, 2012 10:01:17 AM (10 years ago)
Author:
jemian
Message:

revising instructions

Location:
cssboy_deployment/docs
Files:
1 deleted
1 edited

Legend:

Unmodified
Added
Removed
  • cssboy_deployment/docs/source/instructions.rst

    r896 r1051  
    4141where OPI is an EPICS term Operator Programmer Interface)
    4242component which is an EPICS display tool.
    43 For some 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 .. 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
     43
     44        .. tip:: Use the SNS release
     45               
     46                For some time, APS developed a custom CSS product [#aps_css]_ to provide
     47                features and customizations that were not part of the SNS build.
     48               
     49                It is recommended now to use the CSS-BOY as built by the team at
     50                SNS [#css_boy_downloads]_.
     51       
     52        .. note::
     53           You need a Java Runtime Environment (at least) to run CSS.
     54           Also, you will need one or more EPICS IOCs to serve PVs
     55           or all you can do is use the simulator inside CSS.
     56
     57#. Visit this URL and download the most-recent version of
    5558   **Basic EPICS** for your OS:
    5659   http://ics-web.sns.ornl.gov/css/products.html
     
    6366
    6467#. Open the ``CSS_EPICS_3.1.0`` (or whatever version) directory
    65 #. Start ``css`` by double-clicking it
     68#. Start ``css`` by double-clicking it.
     69   If you use a unix or linux command line, type::
     70   
     71       ./css &
     72   
    6673#. Select menu ``File-->Import ...``
    6774#. Open ``General`` category,
     
    6976   click ``Next`` button
    7077#. Click ``Browse ...`` button (in *Import* window),
    71    navigate to ``/APSshare/epics/synApps_5_6/support/all_opi``,
    72    click ``Ok`` button
     78   navigate to ``/APSshare/epics/synApps_5_6/support/``
     79   (or ``/usr/local/epics/synAppsSVN/support/`` or wherever)
     80#. Click ``Ok`` button
    7381#. Click ``Finish`` button (in *Import* window)
     82
     83.. note::  If CSS reports that your synApps directory cannot be imported
     84        since it is not a *project*, you can make it a project by creating
     85        a ``synApps/support/.project`` text XML file with this content::
     86
     87                <?xml version="1.0" encoding="UTF-8"?>
     88                <projectDescription>
     89                        <name>synApps</name>
     90                        <comment>EPICS synApps</comment>
     91                        <projects>
     92                        </projects>
     93                        <buildSpec>
     94                        </buildSpec>
     95                        <natures>
     96                        </natures>
     97                </projectDescription>
     98
    7499
    75100define synApps default fonts and colors
     
    182207        click "Ok" until you out of the dialogs.  Now the paths should work.
    183208
     209
     210Also, when calling a synApps .opi screen from the instrument or beam line, it is not necessary to use the full path since there is an OPI search path that will locate the screen.  Example, instead of::
     211
     212   /synApps/motor/motorApp/op/opi/motor3x.opi
     213
     214you would just call::
     215
     216   motor3x.opi
    184217
    185218
     
    200233Perspective   Defined arrangement of Views and Editors in eclipse.
    201234              A Perspective can be customized and saved within
    202               the Workspace for later recall.
     235              the Workspace for later recall.
    203236View          One type of display in eclipse, some can be undocked
    204237              (or torn-off) so they can be a spearate window.
    205               ??? Are undocked Views saved as part of the
    206               Perspective? ???
     238              ??? Are undocked Views saved as part of the
     239              Perspective? ???
    207240Editor        One type of display in eclipse.
    208241Navigator     Used to browse the Workspace for files and subdirectories.
    209242eclipse       Java-based software providing a configurable interactive
    210243              development environment (IDE).  Eclipse can be highly
    211               customized to deliver a specific application,
    212               such as CSS or CSS-BOY.
     244              customized to deliver a specific application,
     245              such as CSS or CSS-BOY.
    213246CSS           Control System Studio from DESY, based on eclipse
    214247CSS-BOY       CSS Best Opi Yet EPICS Display software (replacement for medm)
    215248============  ==================================================================
    216249
     250
     251.. rubric:: The Glossary
     252
     253.. glossary::
     254
     255Workspace
     256        file system directory containing directories
     257        and files used by a single CSS-BOY user
     258
     259Project
     260        subdirectory within a ``workspace`` containing
     261        related files and subdirectories
     262
     263``.js``
     264        javascript file
     265
     266``.opi``
     267        display screen file used by CSS-BOY
     268
     269Perspective   
     270        Defined arrangement of Views and Editors in eclipse.
     271        A Perspective can be customized and saved within
     272        the Workspace for later recall.
     273
     274View
     275        One type of display in eclipse, some can be undocked
     276        (or torn-off) so they can be a spearate window.
     277        ??? Are undocked Views saved as part of the
     278        Perspective? ???
     279
     280Editor
     281        One type of display in eclipse.
     282
     283Navigator
     284        Used to browse the Workspace for files and subdirectories.
     285
     286eclipse
     287        Java-based software providing a configurable interactive
     288        development environment (IDE).  Eclipse can be highly
     289        customized to deliver a specific application,
     290        such as CSS or CSS-BOY.
     291
     292CSS
     293        Control System Studio from DESY, based on eclipse
     294
     295CSS-BOY
     296        CSS Best Opi Yet EPICS Display software (replacement for medm)
     297
     298
     299--------------------
     300
    217301Footnotes
    218302---------
    219303
    220 .. [#eclipse]           http://eclipse.org
     304.. [#eclipse]                   http://eclipse.org
    221305.. [#css_boy_downloads] http://ics-web.sns.ornl.gov/css/products.html
    222 .. [#css]               http://css.desy.de
    223 .. [#aps_css]           http://css.aps.anl.gov
    224 .. [#synApps]           http://www.aps.anl.gov/bcda/synApps
     306.. [#css]                               http://css.desy.de
     307.. [#aps_css]                   http://css.aps.anl.gov
     308.. [#synApps]                   http://www.aps.anl.gov/bcda/synApps
Note: See TracChangeset for help on using the changeset viewer.