X25 Technical Documents
protein
crystallography
research resource

  EPICS under Vesta for Dummies
Primer
 The EPICS configuration and database files at X25 are under the Vesta software configuration management. Vesta provides (i) version management, (ii) source control, and (iii) a build and make process.

The Vesta service at X25 was implemented in 2004 by Bill Nolan and are now managed by Matt Cowan. Please see him with questions and for help with Vesta or visit this short Vesta Tutorial site.

Vesta maintains an immutable and immortal repository file system from which one can checkout into work directories a copy of selected packages for source development. I.e. in the figure below, the x25 package of major/minor version 2/2 is shown checked out into the /vesta-work space. Note that the repository and the work space are distinct file systems.

In the workspace files are edited, created, and deleted in the usual ways.

When changes are ready for testing, they are stored as minor versions in the repository as well as shipped to the appropriate computer (x25-h or 25-v) by invoking the vmake tool. Minor versions are numbered. The starting version 0 is an exact copy of the checked out package, and each vmake creates a new numbered version in the repository, 1 thru near infinity.

Once a major development step is completed one can check in this latest versions to become a new major version. These are also numbered, typically 0 thru 10. The complete version number is then major/minor. By running vmake on old versions one can always recreate previous trusted code.

Following are five recipes on how to go about changes to the EPICS stuff at X25.

Recipe 1
Who has 		Before editing software, it is best to verify if a package is already checked out into a working directory. For the X25 EPICS stuff this is done by visiting the Vesta repository as follows:
  • Log into x25-h as user epics:
    ssh epics@x25-h.nsls.bnl.gov
  • Find the path to the /vesta file system and server on w04 or munin:
    cd /vesta/w04.nsls.bnl.gov
  • Make your way to the beamline's EPICS repository:
    cd epics/config/x25
  • Ask Vesta if the x25 package is checked out, and if so to whom using:
    vwhohas ./
  • ...$ /vesta/w04.nsls.bnl.gov/epics/config/x25/4 epics@nsls.bnl.gov
    If the answer is as shown above, the beamline's EPICS package major version 4 is already checked out and user epics can begin source modification following the steps in recipe 3. Otherwise go to recipe 2.

Recipe 2
Checkout 		If vwhohas (see recipe 1) reports that the target package is not yet checked out into the users /vesta-work directory fetch the latest version from the repository as follows:
  • In the Vesta repository file system cascade down to the X25 EPICS directory as in recipe 1
    ssh epics@x25-h.nsls.bnl.gov
    cd /vesta/w04.nsls.bnl.gov/epics/config/x25
  • Check out a copy of the latest repository files of the x25 package into /vesta-work directory created for user epics by:
    vcheckout ./

Recipe 3
Change
Code 		Checked out software packages (see recipes 1 or 2) are edited in the /vesta-work directories and then pushed to the application server and the Vesta repository using vmake as follows:
  • Log into x25-h as user epics:
    ssh epics@x25-h.nsls.bnl.gov
  • Change directory to the /vesta-work (not /vesta) file system and to the checked out x25 package:
    cd /vesta-work/epics/x25
  • In the appropriate x25 subdirectory edit the files that need revision. I.e. edit mono.db in the the data base subdirectory (mono calculates the MGU gap from mono angles):
    cd db
    emacs mono.db
  • Change directory back up the the x25 beamline EPICS package and launch vmake using:
    cd ..
    vmake -shipto /tftpboot
    Two actions occur: (1) A new minor version of the x25 package is created in the Vesta repository file system. (2) Vmake ships a fully made executable to x25-h taking into account all dependencies. Note: for vmake to ship the new applications to the X25 processors one must have come here from the x25-h node.
  • Run the new software after rebooting the relevant EPICS IOC: often the VME crate or in this case the EPICS instance running under Linux on x25-h.
  • Note, instead of running vmake which will push the new code to its application node, you may just wish to secure changes made by advancing them into a new repository version. In place of vmake above use:
    vadvance

Recipe 4
Restore
Old 		Previous applications can be restored from the Vesta repository. The exact files, dependencies, libraries, etc that were in use at that previous time will be used to recreate old applications.
  • Log into x25-h as user epics:
    ssh epics@x25-h.nsls.bnl.gov
  • Change directory to the /vesta file system and to the X25 EPICS package:
    cd /vesta/w04.nsls.bnl.gov
    cd epics/config/x25
  • From here, follow the checkout branch, say to find major/minor version 4/2
    cd checkout/4/2
  • Remake this old application and ship it to the X25 nodes. These will need to be rebooted to load and run the restored software.
    vmake -shipto /tftpboot

Recipe 5
Checkin 		Occasionally, and following major systems development, stable new code should be checked into the repository as a new major version. This archiving requires just one additional step, vcheckin, in a sequence that is otherwise the same as the routine code changing in recipe 3.
  • Become epics user on x25-h:
    ssh epics@x25-h.nsls.bnl.gov
  • Cascade down the /vesta-work file system to the the x25 package:
    cd /vesta-work/epics/x25
  • Create a major new version by:
    vcheckin

Updated 10 May 2006 Security Notice   Webteam   Site Map   Bio   PXRR   NSLS   BNL