Changeset 848


Ignore:
Timestamp:
Apr 30, 2012 5:16:57 PM (11 years ago)
Author:
jemian
Message:

update the instructions now

Location:
cssboy_deployment
Files:
1 added
4 edited

Legend:

Unmodified
Added
Removed
  • cssboy_deployment/cssboydeployment.rst

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

    r805 r848  
    44Challenges
    55===================
     6
     7.. warning:: This should be changed to reflect new
     8   pattern discussed at 2012 EPICS Meeting
    69
    710#. CSS-BOY is based in eclipse, which requires all available
  • cssboy_deployment/docs/source/index.rst

    r805 r848  
    2222   plans
    2323   challenges
     24   instructions
    2425
    2526
  • cssboy_deployment/docs/source/plans.rst

    r805 r848  
    44Plans
    55==========================
     6
     7.. warning:: This should be changed to reflect new
     8   pattern discussed at 2012 EPICS Meeting
    69
    710* APS SVN repository for facility screens and other resources
Note: See TracChangeset for help on using the changeset viewer.