Changeset 1060


Ignore:
Timestamp:
Aug 6, 2012 2:17:40 PM (11 years ago)
Author:
jemian
Message:

checkpoint

Location:
cssboy_deployment/docs/source
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • cssboy_deployment/docs/source/configure.rst

    r1059 r1060  
    11.. $Id$
    22
    3 ==========================
    4 Configuration
    5 ==========================
     3=============
     4Configuration
     5=============
     6
     7The steps on this page are done from within CSS-BOY.
     8
     9#. Open the ``CSS_EPICS_3.1.1`` (or whatever version) directory
     10#. Start ``css`` by double-clicking it.
     11   If you use a unix or linux command line, type::
     12   
     13       ./css &
     14   
     15
     16Workspace
     17======================
     18
     19When CSS-BOY starts, it will prompt you to make a choice of which workspace to use.
     20
     21.. note:: It is possible to suppress this prompt if you wish to always
     22        use the same workspace by clicking the *Ask Again?* checkbox on the prompt screen.
     23        To return to this prompt screen, select the menus ``File`` and then
     24        ``Switch Workspace...``.
     25
     26:index:`APS_sr` Project
     27===================================
     28
     29this work has not been done yet,
     30the screens are not ready,
     31the instructions are not ready
     32
     33.. TODO
     34        Do NOT forget to update the OPI Search Path instructions, when these screens become available
     35
     36:index:`synApps` Project
     37===================================
     38
     39
     40:index:`color.def` file
     41===========================================================
     42
     43
     44:index:`fonts.def` file
     45===========================================================
     46
     47
     48Setting the EPICS Address List and Repeater
     49===========================================================
     50
     51add an IP for the gateway
     52
     53check the auto_addr_list
     54
     55
     56Setting the :index:`OPI Search Path`
     57===========================================================
     58
     59.. TODO
     60        Do NOT forget to add the APS_sr screens, when they become available
     61
     62
     63Creating the Beam Line Project
     64===========================================================
     65
     66
     67Calling synApps screens
     68===========================================================

  • cssboy_deployment/docs/source/glossary.rst

    r1059 r1060  
    11.. $Id$
    22
    3 ==========================
     3========
    44Glossary
    5 ==========================
     5========
    66
    77Some of the terms used by eclipse and CSS and CSS-BOY may be unfamiliar.
    … …  
    99.. glossary::
    1010
     11
     12.. index:: ! .js file
     13
    1114``.js``
    1215        javascript file
    1316
     17
     18.. index:: ! .opi file
     19
    1420``.opi``
    15         display screen file used by CSS-BOY
     21        XML-based display screen description file used by CSS-BOY
     22
    1623
    1724:index:`CSS`
    … …  
    2835
    2936:index:`Editor`
    30         One type of display screen within eclipse.
     37        One type of display screen within eclipse.  Compare with *View* (below).
    3138
    3239:index:`MEDM`
    … …  
    4855:index:`View`
    4956        One type of display screen within eclipse.
    50         Some Views can be undocked (or torn-off) so they can be a separate window.
     57        Compare with *Editor* (above).
     58
     59        Some Views can be detached (also called
     60        *undocked* or *torn-off*) so they can become a separate window.
     61        (This is the only type of window in MEDM.)
    5162       
    52         ??? Are undocked Views saved as part of the Perspective? ???
     63        * Saved Perspectives do not remember detached Views.
     64        * A session can restart with its detached View still in place.
    5365
    5466:index:`Workspace`
    … …  
    5971
    6072Footnotes
    61 ++++++++++++++++++++++++++++++++
     73=========
    6274
    63 .. [#eclipse]                   http://eclipse.org
    64 .. [#css]                               http://css.desy.de
     75
     76.. [#css] Control System Studio: http://css.desy.de
     77.. [#css_boy_downloads] http://ics-web.sns.ornl.gov/css/products.html
     78.. [#aps_css] http://css.aps.anl.gov
     79.. [#eclipse] http://eclipse.org
     80.. [#epics] Experimental Physics and Industrial Control System: http://www.aps.anl.gov/epics
     81.. [#medm] Motif-based Editing and Display Manager: http://www.aps.anl.gov/epics/extensions/medm/index.php
     82.. [#synApps] Software for control of an APS beam line:  http://www.aps.anl.gov/bcda/synApps

  • cssboy_deployment/docs/source/index.rst

    r1059 r1060  
    11.. $Id$
    22
    3 Welcome to cssboydeployment's documentation!
    4 ============================================
     3Deploying CSS-BOY at APS Beam Lines
     4===================================
    55
    66Purpose
    77---------
    88
    9 :index:`! CSS-BOY` is graphical-user interface software for EPICS,
    10 maintained and distributed by the SNS.  Separate executables are
     9
     10:index:`CSS` [#css]_ (Control System Studio) was designed at DESY, Hamburg, Germany. 
     11CSS is software that provides a rich environment for :index:`EPICS` [#epics]_ controls.
     12
     13.. index:: EPICS; OPI
     14
     15The Spallation Neutron Source at Oak Ridge National Laboratory
     16maintains and distributes a tool derived from CSS,
     17:index:`CSS-BOY` (Best Opi Yet --
     18where OPI is an EPICS term for Operator - Programmer Interface).
     19CSS-BOY  is graphical-user interface software for EPICS.  Separate executables are
    1120provided for Windows, MacOS, and Linux operating systems.
    12 It is intended to use CSS-BOY to replace :index:`MEDM` at APS beam lines.
     21It is intended to use CSS-BOY to replace :index:`MEDM` [#medm]_ at APS beam lines.
     22
     23APS beam lines will deploy CSS-BOY expecting to
     24use standard screens from the APS, as well as
     25locally-produced screens.  Each beam line will need to
     26install identical customizations at several beam line
     27workstations.   The APS will need occasionally to update
     28the suite of standard screens.
    1329
    1430This document describes the steps to install and configure
    … …  
    2844
    2945
     46..
     47        Indices and tables
     48        ==================
     49       
     50        * :ref:`genindex`
     51        * :ref:`search`
    3052
    31 Indices and tables
    32 ==================
    3353
    34 * :ref:`genindex`
    35 * :ref:`search`
     54.. note:: This documentation comes from a SVN repo:
    3655
     56        ::
     57
     58                svn co https://subversion.xray.aps.anl.gov/bcdaext/cssboy_deployment cssboy_deployment
     59
     60
     61-----------------------
     62       
     63.. rubric:: Footnotes
     64
     65.. [#css]       Control System Studio: http://css.desy.de
     66.. [#epics]     Experimental Physics and Industrial Control System: http://www.aps.anl.gov/epics
     67.. [#medm] Motif-based Editing and Display Manager: http://www.aps.anl.gov/epics/extensions/medm/index.php

  • cssboy_deployment/docs/source/install.rst

    r1059 r1060  
    11.. $Id$
    22
    3 ==========================
    4 Installation
    5 ==========================
     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
     55some users want to use this with CSS-BOY
     56
     57http://subclipse.tigris.org/updates  /...
     58
     59Problems with getting the architecture and versions and other stuff just right
     60
     61Mac user still has problems.  Java-hl support.  Start with svn v1.6 and get both java tools, then upgrade "and pick the other tool." ...
     62
     63Mac users of Apple Firewall will be annoyed by a recurrent prompt.
     64
     65.. warning:  This needs to be worked out
     66
     67:index:`synApps`
     68================
     69
     70Getting the synApps OPI screens from some place
     71-----------------------------------------------------
     72
     73To get the synApps OPI screens, you need to do one of the following
     74(subject to revision):
     75
     76#. import synApps project from /APSshare (for APS beam lines)
     77        path:   /APSshare/epics/synApps_5_6/support/all_opi
     78
     79
     80#. checkout synApps development trunk from SVN, then import as project
     81        There is a linux shell script to do the checkout::
     82
     83                https://subversion.xor.aps.anl.gov/synApps/support/trunk/checkout.csh
     84       
     85        One way is to place this file in */usr/local/epics* and then run it.
     86        It will create a directory called *synAppsSVN/support* that contains
     87        the development trunk.
     88
     89
     90#. checkout a snapshot of the
     91        synApps OPI screens::
     92
     93                svn co https://subversion.xray.aps.anl.gov/bcdaext/cssboy_deployment/all_opi/ ./all_opi
     94       
     95        .. caution::
     96                Note that this subversion repository is a copy from the synApps development trunk
     97                on a certain date and may not contain the most recent modifications!
     98
     99
     100
     101
     102---------------------------------------
     103
     104.. rubric:: Footnotes
     105
     106.. [#css_boy_downloads] http://ics-web.sns.ornl.gov/css/products.html
     107.. [#aps_css] http://css.aps.anl.gov
     108.. [#synApps] Software for control of an APS beam line:  http://www.aps.anl.gov/bcda/synApps

  • cssboy_deployment/docs/source/layout.rst

    r1059 r1060  
    11.. $Id$
    22
    3 ==========================
     3======
    44Layout
    5 ==========================
     5======
    66
     7CSS-BOY is based on :index:`eclipse` [#eclipse]_ and thus,
     8shares many of the eclipse design concepts.
     9
     10Workspace
     11=========
     12
     13The first eclipse design concept is that of the :index:`Workspace`.
     14In eclipse, a *Workspace* is a logical grouping of common projects
     15(usually software source code).  This grouping often corresponds to
     16a specific directory (and subdirectories) on a computer's disk storage.
     17The default CSS-BOY *Workspace* is ``CSS-Workspaces/default`` and is located
     18in the user's home directory.
     19
     20        In this documentation, we will assume we use the default CSS-BOY
     21        Workspace.  This assumption is only important when describing which
     22        workspace we are using.  All other instructions are independent of the
     23        chosen workspace.
     24
     25.. index:: Workspace; sharing
     26
     27.. important::
     28        You can't share the CSS Workspace with another user,
     29        even if that other user is logged in with the same name
     30        (such as yourself, logged in more than once).
     31        This will likely cause abnormal behavior for CSS.
     32        But, you *can reference the same file system directory* from several
     33        different CSS-BOY workspaces by importing that directory as a project
     34        into each workspace.
     35
     36Projects
     37========
     38
     39An eclipse *Project* contains all the file resources (source code,
     40data files, images, documentation, ...) related to a certain activity.
     41In eclipse, a project might be the source code tree of a piece of software.
     42In CSS-BOY, it is a set of screen description (.opi ) files and related
     43images and javascript files.  Generally, everything that is within a project
     44will come from one source, such as a shared file directory or version
     45control repository.
     46
     47Install OPI screens into projects within your workspace.  The OPI screens
     48from :index:`synApps` [#synApps]_ will go into their own project within your
     49workspace.  The screens from the APS accelerator will go into another
     50project.  Your instrument and beam line screens will typically go into
     51a single project but it is possible that you might have separate projects
     52for upstream optics, beam line staff, and users.
     53
     54        Each *project* within CSS may come from a separate location:
     55       
     56        * local directory within your account and CSS workspace
     57        * file server accessible from your directory space
     58        * NFS or SMB (Samba) file server
     59        * Version Control working directory
     60       
     61To be an eclipse :index:`Project`, a directory must contain
     62a file named ``.project`` with contents similar to this
     63:ref:`example <synApps.project.file>`.
     64
     65
     66.. sidebar:: You've got choices here...
     67
     68        You might not want to create separate projects for each station on the
     69        beam line.  Choose a scheme that works well for your situation.
     70
     71Recommended Layout of Projects
     72==============================
     73
     74Within the selected Workspace, the recommended layout of projects is as follows:
     75
     76.. code-block:: text
     77        :linenos:
     78       
     79        /APS_sr/
     80        /CSS/
     81        /ioc45ida/
     82        /ioc45idb/
     83        /synApps/
     84
     85Each of these lines is a :index:`Project`, described as follows:
     86
     87``APS_sr``
     88        Screen definitions (.opi files) and related resources (such as graphics
     89        or javascript) as provided by the APS to access controls in the beam line
     90        front ends and storage ring.
     91       
     92        .. caution:: TODO items here
     93
     94                * no screens have been converted yet
     95                        * target just the ``/APSshare/adlsys/sr/fe`` for conversion?
     96                        * install to ``/APSshare/APS_sr`` (outside adlsys since it is receiver of rsync task)
     97                        * create an SVN repo to hold these converts?
     98                * Needs ``opi_search_path`` terms
     99
     100``CSS``
     101        The default project in a CSS-BOY Workspace. 
     102        Use this only for development or other temporary purposes (that is, a *sandbox*).
     103        Otherwise, leave it empty.
     104
     105``ioc45ida``
     106        Example project to contain screen definitions and related definitions
     107        (.opi files) and related resources (such as graphics or javascript)
     108        for the hypothetical beam line 45-ID A station (as if these files
     109        might be separate from the B station on the beam line).
     110       
     111        **Use a project like this for your specific beam line, instrument, or station needs.**
     112       
     113        .. note:: It is urged that this project be placed under version control (such as subversion).
     114
     115``ioc45idb``
     116        Example project to contain screen definitions and related definitions
     117        (.opi files) and related resources (such as graphics or javascript)
     118        for the hypothetical beam line 45-ID B station (as if these files
     119        might be separate from the A station on the beam line).
     120       
     121        **Use a project like this for your specific beam line, instrument, or station needs.**
     122       
     123        .. note:: It is urged that this project be placed under version control (such as subversion).
     124
     125``synApps``
     126        Screen definitions (.opi files) and related resources (such as graphics
     127        or javascript) as provided by the APS BCDA group to access common beam line
     128        controls.
     129
     130        * import *synApps* from ``/APSshare/epics/synApps_5_6`` or equal (for beam line workstations)
     131        * import from SVN checkout (working directory) (for laptop users)
     132        * import from tarball extraction (other users)
     133
     134
     135-----------------------
     136       
     137.. rubric:: Footnotes
     138
     139.. [#eclipse]                   http://eclipse.org
     140.. [#synApps]   Software for control of an APS beam line.  http://www.aps.anl.gov/bcda/synApps

  • cssboy_deployment/docs/source/plans.rst

    r1059 r1060  
    66
    77
    8 APS beam lines will deploy CSS-BOY expecting to
    9 use standard screens from the APS, as well as
    10 locally-produced screens.  Each beam line will need to
    11 install identical customizations at several beam line
    12 workstations.   The APS will need occasionally to update
    13 the suite of standard screens.
    14 
    15 
    16 .. note:: These notes should be changed to reflect the new
    17    pattern discussed at 2012 EPICS Meeting
    18 
    19 * use new OPI search path
    20 * synApps screens imported as *synApps* project
    21         * import from ``/APSshare/epics/synApps_5_6`` or equal
    22         * import from SVN checkout (working directory)
    23         * import from tarball extraction
    24 
    25 * APS facility screens imported as *APS_sr* project
    26         * no screens have been converted
    27                 * target just the ``/APSshare/adlsys/sr/fe`` for conversion?
    28                 * install to ``/APSshare/APS_sr`` (outside adlsys since it is receiver of rsync task)
    29                 * create an SVN repo to hold these converts?
    30 
    31         * same priority of imports as synApps
    32 
    33 * beam line-specific screens as one or more projects
    34         * local file system, outside of any one CSS-BOY workspace
    35         * urge that it go into an SVN repo
    36         * import into client workspaces
    37 
    38 * documentation!
    39 
     8morendo ...
    409
    4110

  • cssboy_deployment/docs/source/thoughts.rst

    r1058 r1060  
    11.. $Id$
    22
    3 ==========================
     3============
    44Instructions
    5 ==========================
    6 
    7 .. caution:: At this time, this documentation is a collection of notes
    8         related to installation or configuration of CSS-BOY.  It needs to be
    9         set into some sort of order.
    10 
    11 
    12 .. note:: This comes from a SVN repo:
    13 
    14         ::
    15 
    16                 svn co https://subversion.xray.aps.anl.gov/bcdaext/cssboy_deployment cssboy_deployment
    17 
    18 Install OPI screens (and other resources such as image files, javascript,
    19 or definition files) into projects within your workspace.  The OPI screens
    20 from *synApps* [#synApps]_ will go into their own project within your
    21 workspace.  The screens from the APS accelerator will go into another
    22 project.  Your instrument and beam line screens will typically go into
    23 a single project but it is possible that you might have separate projects
    24 for upstream optics, beam line staff, and users.
    25 
    26   Each *project* within CSS may come from a separate location:
    27  
    28   * local directory within your account and CSS workspace
    29   * file server accessible from your directory space
    30   * NFS or SMB (Samba) file server
    31   * Version Control working directory
    32  
    33   You can't share the CSS Workspace with another user,
    34   even if that other user is logged in with the same name.
    35   This will likely cause abnormal behavior for CSS.
    36   **But**, you can import a common or shared directory into your CSS
    37   workspace.
    38 
    39 Leave the *CSS* project for use as a sandbox (special area for files
    40 which you are testing or using for a short time and do not wish to treat
    41 as part of everyone's workspace).
    42 
    43 
    44 Install CSS-BOY on your computer
    45 ++++++++++++++++++++++++++++++++
    46 
    47 CSS [#CSS]_ (Control System Studio) was designed at DESY, Hamburg, Germany. 
    48 CSS is software that provides a rich
    49 environment for EPICS controls.
    50 
    51 The SNS at ORNL added the BOY (Best Opi Yet --
    52 where OPI is an EPICS term Operator Programmer Interface)
    53 component which is an EPICS display tool.
    54 
    55         .. tip:: Use the SNS release
    56                
    57                 For some time, APS developed a custom CSS product [#aps_css]_ to provide
    58                 features and customizations that were not part of the SNS build.
    59                
    60                 It is recommended now to use the CSS-BOY as built by the team at
    61                 SNS [#css_boy_downloads]_.
    62        
    63         .. note::
    64            You need a Java Runtime Environment (at least) to run CSS.
    65            Also, you will need one or more EPICS IOCs to serve PVs
    66            or all you can do is use the simulator inside CSS.
    67 
    68 #. Visit this URL and download the most-recent version of
    69    **Basic EPICS** for your OS:
    70    http://ics-web.sns.ornl.gov/css/products.html
    71    
    72    (Alternative URL: https://ics-web.sns.ornl.gov/css/updates/apps/ )
    73 #. Unzip the contents someplace.  Typical for me is:
    74    ``~/Apps/CSS_EPICS_3.1.1``
    75 
    76 
    77 
    78 
    79 Getting the synApps OPI screens from some place
    80 -----------------------------------------------------
    81 
    82 To get the synApps OPI screens, you need to do one of the following
    83 (subject to revision):
    84 
    85 #. import synApps project from /APSshare
    86         path:   /APSshare/epics/synApps_5_6/support/all_opi
    87 
    88 
    89 #. checkout synApps development trunk from SVN, then import as project
    90         There is a script to do the checkout::
    91 
    92                 https://subversion.xor.aps.anl.gov/synApps/support/trunk/checkout.csh
    93        
    94         One way is to place this file in */usr/local/epics* and then run it.
    95         It will create a directory called *synAppsSVN/support* that contains
    96         the development trunk.
     5============
     6
     7
    978
    989
    … …  
    11728#. Click ``Finish`` button (in *Import* window)
    11829
     30.. _synApps.project.file:
     31
    11932.. note::  If CSS reports that your synApps directory cannot be imported
    12033        since it is not a *project*, you can make it a project by creating
    … …  
    12538                        <name>synApps</name>
    12639                        <comment>EPICS synApps</comment>
    127                         <projects>
    128                         </projects>
    129                         <buildSpec>
    130                         </buildSpec>
    131                         <natures>
    132                         </natures>
     40                        <projects/>
     41                        <buildSpec/>
     42                        <natures/>
    13343                </projectDescription>
    13444
    … …  
    350260
    351261
    352 Glossary of Terms
    353 ++++++++++++++++++++++++++++++++
    354 
    355 Some of the terms used by eclipse and CSS and CSS-BOY may be unfamiliar.
    356 
    357 .. glossary::
    358 
    359 ``.js``
    360         javascript file
    361 
    362 ``.opi``
    363         display screen file used by CSS-BOY
    364 
    365 CSS
    366         Control System Studio [#css]_ from DESY, based on eclipse
    367 
    368 CSS-BOY
    369         CSS Best Opi Yet EPICS Display software (replacement for medm)
    370 
    371 eclipse
    372         Java-based software providing a configurable interactive
    373         development environment (IDE).  Eclipse [#eclipse]_ can be highly
    374         customized to deliver a specific application,
    375         such as CSS or CSS-BOY.
    376 
    377 Editor
    378         One type of display in eclipse.
    379 
    380 Navigator
    381         Used to browse the Workspace for files and subdirectories.
    382 
    383 Perspective   
    384         Defined arrangement of Views and Editors in eclipse.
    385         A Perspective can be customized and saved within
    386         the Workspace for later recall.
    387 
    388 Project
    389         subdirectory within a *workspace* containing
    390         related files and subdirectories
    391 
    392 View
    393         One type of display in eclipse, some can be undocked
    394         (or torn-off) so they can be a spearate window.
    395        
    396         ??? Are undocked Views saved as part of the Perspective? ???
    397 
    398 Workspace
    399         file system directory containing directories
    400         and files used by a single CSS-BOY user
    401 
    402262
    403263
Note: See TracChangeset for help on using the changeset viewer.