1 arta  1.1 			Release Notes JSOC V1.0		19Oct2005
  2           			-----------------------		---------
  3           
  4           
  5           The official release version is in /home/production/cvs/jsoc.
  6           This will remain unchanged until the next release.
  7           You may make any changes you want in your sandbox, but anything that you 
  8           commit will appear in the next offical release.
  9           
 10           ****************************** Sandbox ***************************************
 11           
 12           You need a cvs "sandbox" to contain your view of the V1.0 release:
 13           (There is no need to do this unless you're going to be a developer in V1.0)
 14           
 15           Set the env variables:
 16           CVSROOT=:ext:sunroom.stanford.edu:/home/cvsuser/cvsroot
 17           CVS_RSH=ssh
 18           
 19           Make a cvs dir and do:
 20           
 21           > cd /home/you/cvs
 22 arta  1.1 > cvs checkout jsoc
 23           
 24           This will give you a sandbox. You now need to make on linux_ia32, linux_ia64 or
 25           linux_x86_64 machines:
 26           
 27           > ssh lws		(and then again for n12 and xim)
 28           > cd /home/you/cvs/jsoc
 29           > ./configure -force -client
 30           > make clean
 31           > make -j 4  		(run 4 jobs in parallel for speed)
 32           
 33           Set your path for /home/you/cvs/jsoc/bin/linux_ia64 (or linux_x86_64 or
 34           linux_ia32)
 35           
 36           The command 
 37           
 38           > configure -help
 39           
 40           will print information about how to create a customized build,
 41           to e.g. use a different compiler or turn on debugging flags.
 42           
 43 arta  1.1 If you are unfamiliar with the use of cvs see the file:
 44           jsoc/CM/<version>/working_with_sandbox.txt. 
 45           
 46           
 47           There's a linux4 cvs gui at xim:/usr/bin/lincvs
 48           
 49           ****************************** SUMS ******************************************
 50           
 51           The Storage Unit Management (SUM) subsystem is discussed and its API
 52           presented in:
 53           
 54           http://sun.stanford.edu/web.hmi/development/SU_Development_Plan/SUM_API.html
 55           
 56           The V1.0 restrictions are:
 57           
 58             *Disk storage only supported. No archiving or retrieving from tape.
 59           
 60             *Everything should work until the SUM storage disks fill up. Then 
 61              storage allocation errors will occur.
 62           
 63             *No SUM db backup is performed.
 64 arta  1.1 
 65             *All V1.0 SUM storage units (and keywords) created are considered transient 
 66              and will not necessarily be propagated forward to future releases.
 67           
 68             *No memory leak detection has been performed.
 69           
 70             *Must be compiled with gcc. icc gives seg fault when this is false:
 71                   if(p == q_rd_front)
 72           
 73           The /SUM partitions are:
 74           d00:/home/jim> ll /SUM*
 75           lrwxrwxrwx  1 root root 10 Sep 26 14:16 /SUM1 -> /hmi0/SUM1/
 76           lrwxrwxrwx  1 root root 10 Sep 26 14:18 /SUM2 -> /hmi1/SUM2/
 77           lrwxrwxrwx  1 root root 10 Sep 26 14:19 /SUM3 -> /hmi2/SUM3/
 78           lrwxrwxrwx  1 root root 10 Sep 26 14:21 /SUM4 -> /hmi0/SUM4/
 79           lrwxrwxrwx  1 root root 10 Sep 26 14:22 /SUM5 -> /hmi1/SUM5/
 80           
 81           For V1.0 the sum_svc runs on lws (will eventually be d00). It is started by:
 82           /home/production/cvs/jsoc/bin/linux_ia64/sum_svc &
 83           Log files are in /usr/local/logs/SUM/.
 84           
 85 arta  1.1 
 86           The SUM database is ORACLE_SID=hmidb on host hmidb.
 87           The SUM related tables are:
 88           
 89           	sum_open
 90           	sum_main
 91           	sum_tape
 92           	sum_partn_alloc
 93           	sum_partn_avail
 94           
 95           Web page access is at http://soi/production/forms.hmidb_SUMS.html
 96           
 97           The schema is in hmidb:/home/ora10/SUM.
 98           
 99           The DB is started on hmidb as user ora10:
100           > cd /home/ora10
101           > ./dbstart_hmidb
102           > ./net_start
103           
104           The DB is stopped on hmidb as user ora10:
105           > cd /home/ora10
106 arta  1.1 > ./dbshut_hmidb
107           > ./net_stop
108           
109           
110           ************************** DRMS ***********************
111           
112           The Data Record Management System (DRMS) is discussed in 
113           
114             http://sun.stanford.edu/web.hmi/development/JSOC_Documents/DRMS_V10.pdf
115           
116           which explains the motiviation and conceptual design.
117           
118           Creating and running DRMS modules is discussed in 
119           
120             jsoc/CM/<version>/drms_module.txt
121           
122           The current user-level DRMS API is discussed in 
123            
124             jsoc/CM/<version>/drms_api.txt
125           
126           
127 arta  1.1 DRMS uses the PostgreSQL database called "jsoc" on the host
128           "hmidb.stanford.edu". 
129           
130            * To use DRMS you must have a user account in the database. 
131              Contact Rasmus Munk Larsen (rmunk@quake.stanford.edu) to obtain 
132              such an account. 
133            * The database is continuously backed up to disk using the Point In Time 
134              Recovery mechanism. We do not yet have tape backups running.
135            * A full table dump (to disk) and table maintenance (VACUUM ANALYZE) is 
136              performed every Monday morning at 2am (dump) and 4am (vacuum). Expect 
137              some performance degradation for modules with heavy database usage at 
138              such times.
139            * The database is stopped and started (as root) with 
140              > service postgresql stop
141              > service postgresql start
142           
143           To compile and run the DRMS server, the following RPMs must be installed
144           installed on the machine:
145           
146           postgresql
147           postgresql-devel
148 arta  1.1 postgresql-libs
149           openssl-devel