ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/SCRAM/doc/html/project.html
Revision: 1.6
Committed: Wed May 15 14:23:33 2002 UTC (23 years ago) by sashby
Content type: text/html
Branch: MAIN
CVS Tags: V0_19_6, V0_19_6p1, V0_19_5, SFATEST, V0_19_4, V0_19_4_pre3
Branch point for: V0_19_4_B
Changes since 1.5: +22 -17 lines
Log Message:
Updated documentation.

File Contents

# User Rev Content
1 williamc 1.1 <! Style Sheet Header>
2     <html>
3     <head>
4     <title>project.html</title>
5 williamc 1.3 <body bgcolor=beige>
6 williamc 1.1 <! End Style Sheet Header -----------Insert Text Here --------------------->
7     <center>
8     <h1>Installing a Project Using SCRAM</h1>
9 williamc 1.3 <font color=red>S</font>oftware <font color=red>C</font>onfiguration,
10     <font color=red>R</font>elease <font color=red>A</font>nd
11     <font color=red>M</font>anagement
12 williamc 1.1 </center>
13     <hr>
14 williamc 1.3 It is envisaged that releases of a project need to be distributed to remote
15     sites. The release is contained in a special scram area which is created
16     by scram according to the projects requirements. Once a carbon copy of the area
17 sashby 1.6 has been built on the remote site, the administrator can "scram install" it
18 williamc 1.3 into the remote sites scram database. Once installed many other scram
19 sashby 1.6 development areas can be based upon it, for use by other users,developers etc.
20 williamc 1.3 <p>
21 williamc 1.1 SCRAM aims to make installion of projects as painless a possible.
22 sashby 1.6 It is designed to be used with a web browser so that you simply click on a link to start the installation
23 williamc 1.1 process.
24     <p>
25     You will be asked questions about your system as required by the project during
26 sashby 1.6 the installation. Some basic error and consistency checking is provided.
27     These values can be changed later (see below)
28 williamc 1.3 so dont worry too much if you get things wrong at this stage.
29 williamc 1.1 <p>
30     Once through the installation process you can make the project available for
31 williamc 1.3 general use by using the <em>scram install</em> command. This command will
32 williamc 1.1 update your local SCRAM database with the project details so that other
33 sashby 1.6 SCRAM user can simply refer to it by name and version.
34 sashby 1.5 <p>
35    
36     <h2>Automated setup procedure for new project areas</h2>
37     The setup procedure is first invoked for a new project area to set up the tools selected via the
38     RequirementsDoc. This is now automated by using site information read from a configuration file.
39     The configuration file is called cmstools-SITENAME.conf, where SITENAME is the name of your
40     site (the default is CERN). The sitename can be changed by modifying the file <em>sitename</em>.
41     These files reside in the configuration area for each SCRAM-based project under
42     a subdirectory <em>site</em>. The configuration file contains default paths to tools,
43     especially ANAPHE tools, which scram will use first to find locations of libraries and
44     include files.
45 sashby 1.6 At remote sites that have read access to the CVS repository only, and want to install a project
46     that was previously released at CERN, the sitename can be chosen during scram installation.
47     An optional flag to the project command can allow the administrator to specify the cmstools file to read.
48     A default location for this file can also be chosen during scram installation.
49     <p>
50 sashby 1.5 Here is an extract from the CERN configuration file:
51     <pre>
52    
53     ###############################################################
54     # cmstools-CERN.conf #
55     ###############################################################
56     # modified : Tue Nov 20 11:39:49 2001 / SFA #
57     # : #
58     # : #
59     # function : Configuration file for setting up ANAPHE and CMS #
60     # : tools at CERN. #
61     # : #
62     ###############################################################
63     # Set some ANAPHE variables.
64     # Specify the OS. All subsequent defns will be for this OS:
65     ANAPHEOS:Linux
66     # ANAPHE version:
67     ANAPHEVER:3.6.2
68     # Specify the top of the ANAPHE tool dir, excluding the version:
69     ANAPHETOP:/afs/cern.ch/sw/lhcxx/specific/redhat61/gcc-2.95.2
70     #
71     CMSTOOL:g77:
72     +FC:/usr/local/gcc-alt-2.95.2/bin/g77
73     CMSTOOL:gcc:
74     +CXX:/usr/local/gcc-alt-2.95.2/bin/c++
75     +CC:/usr/local/gcc-alt-2.95.2/bin/gcc
76     +LD_LIBRARY_PATH:/usr/local/gcc-alt-2.95.2/lib
77     CMSTOOL:htl:
78     +SCHEMA_HOME:/afs/cern.ch/sw/lhcxx/share/HTL/1.3.1.1/schema
79     CMSTOOL:zlib:
80     +ZLIB_BASE:/afs/cern.ch/cms/Releases/sw/zlib/Linux__2.0/zlib-1.1.3
81     # Specify the OS. All subsequent defns will be for this OS:
82     ANAPHEOS:SunOS
83     # ANAPHE version:
84     ANAPHEVER:3.6.2
85     # Specify the top of the ANAPHE tool dir, excluding the version:
86     ANAPHETOP:/afs/cern.ch/sw/lhcxx/specific/sun4x_57/CC-5.2
87     #
88     CMSTOOL:f77:
89     +FC:/afs/cern.ch/project/sun/solaris/opt/SUNWspro61/bin/f77
90     CMSTOOL:cc:
91     +CXX:/afs/cern.ch/project/sun/solaris/opt/SUNWspro61/bin/CC
92     +CC:/afs/cern.ch/project/sun/solaris/opt/SUNWspro61/bin/cc
93     +CXX_PRIOR_LIBS:/afs/cern.ch/project/sun/solaris/opt/SUNWspro61/WS6U1/lib
94     CMSTOOL:htl:
95     +SCHEMA_HOME:/afs/cern.ch/sw/lhcxx/share/HTL/1.3.1.1/schema
96     CMSTOOL:zlib:
97     +ZLIB_BASE:/afs/cern.ch/cms/Releases/sw/zlib/SunOS__5.6/zlib-1.1.3
98    
99     </pre>
100    
101     For ANAPHE tools under linux, the default path is ANAPHETOP and normally the libraries are
102     found under a subdirectory matching the ANAPHE version (set using the variable ANAPHEVER
103     in the above file).
104     If a tool is not likely to be found under this default path, an entry is made in the file.
105     This entry begins with CMSTOOL and the tool name (as known to scram), and any variables
106     that scram must set for this tool are subsequently listed, each entry beginning
107     with a plus sign.
108     <p>
109     When setting up the tools, scram reads this file and creates a lookup-table. If the default search fails,
110     scram looks for an entry in the lookup table for the tool. If an entry exists, subsequent
111     values for the scram variables will be used. If no entry is found, scram will drop to an interactive
112     environment and request user input.
113    
114 williamc 1.1 <p>
115 williamc 1.2 <h2>Changing Installation Defaults</h2>
116 sashby 1.6 You can use the command<P>
117     <pre>
118     scram setup [-i] [-f cmstools.conf] tool_name [[<em>tool_version</em>] [<em>tool_file</em>]]
119     </pre>
120     to rerun the setup of a specific tool.<p>
121     The <b>-f</b> flag causes setup to read the filename given. This filename must end in ".conf".
122     <p>
123 williamc 1.3 You can override the automatic mechanisms that
124 sashby 1.6 SCRAM uses to install a tool with the <b>-i</b> option, or if this is not sufficient,
125 williamc 1.3 <br>
126 sashby 1.6 you can modify the values directly. Simply edit the appropriate <em>.dat</em> file
127     in the .SCRAM/SCRAM_ARCH directory from the top of the project installation.
128     <p>
129 williamc 1.1 <! Style Sheet Footer ---------------Do not change anything after this line-->
130     <hr>
131     <table border=1 width=100%>
132     <td align=left>
133 sashby 1.4 <a href=mailto:Shaun.Ashby@cern.ch
134     >Shaun Ashby</a>
135 williamc 1.1 </td>
136     <td align=center>
137     <script language="JavaScript">
138     <!---//hide script from old browsers
139     document.write( "<br>Last updated "+ document.lastModified
140     );
141     //end hiding contents --->
142     </script>
143     </td>
144     <td align=right>Show <a href=/cgi-cmc/pagestat>Stats</a>
145     </td>
146     </table>
147     </body> </html>
148     <! End Style Sheet Footer>