ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/README
Revision: 1.2
Committed: Fri Mar 21 18:48:44 2003 UTC (20 years, 11 months ago) by greg
Branch: MAIN
CVS Tags: rad3R5
Changes since 1.1: +4 -4 lines
Log Message:
Final updates for official 3.5 release

File Contents

# User Rev Content
1 greg 1.1 RCSid "$Id"
2    
3     Hello and welcome to the Radiance synthetic imaging system. This is
4     the thirteenth release, Version 3.5, and it includes all source files
5     for local compilation with a standard C compiler. To find out what's
6     new in this release, check the text file "doc/notes/ReleaseNotes".
7    
8     Radiance is OpenSource software copyrighted and distributed by
9     Lawrence Berkeley National Laboratory in California. By downloading
10     and installing this software, you are implicitly agreeing to the
11     OpenSource license appended to this README file. Please read it
12     carefully before proceeding -- this is very different from previous
13     licenses, and contains fewer restrictions on commercialization.
14    
15     Please read this entire file before sending e-mail asking
16     how to install this software or what to do with it. Some
17     frequently asked questions are answered here and also on our
18     web site at:
19    
20     http://radsite.lbl.gov/radiance/
21    
22     The website above should also have some precompiled Radiance binaries
23     and add-ons for common Unix platforms.
24    
25     We have attempted to make it easy for you (and for us) to install
26     the software on differently configured systems using a global make
27     script. To install the software, just type:
28    
29 greg 1.2 ./makeall install
30 greg 1.1
31     You can clean up the .o files and so forth with:
32    
33 greg 1.2 ./makeall clean
34 greg 1.1
35     Or, if you are confident you can do both at the same time with:
36    
37 greg 1.2 ./makeall install clean
38 greg 1.1
39     You can give other make options at the end of the command as well. For
40     example, the -n option will tell you what makeall is going to do without
41     actually doing it.
42    
43     If you downloaded the binaries, so compilation is not necessary,
44     run the following command to install the library files only:
45    
46 greg 1.2 ./makeall library
47 greg 1.1
48     The makeall may script ask you questions about your system and where you
49     want to install the executables and library files. The pathnames you
50     give should be relative to root for the programs to work properly. You
51     may also use the tilde ('~') character to give paths starting with
52     someone's home directory.
53    
54     If you do NOT have X11 support, please read the note "noX11.help" in
55     this directory. It explains what to change to make things work.
56    
57     Although it is set automatically by makeall, individuals may want to
58     set the RAYPATH environment variable manually. This variable tells
59     Radiance where to look for auxiliary files, and usually includes the
60     current directory as well as the system library (ray/lib in this
61     distribution). As you develop auxiliary files yourself, it is often
62     useful to add in your own library directory before the system directory.
63     An example setting such as this would go in a user's .login file:
64    
65     setenv RAYPATH .:${HOME}/mylib:/usr/local/lib/ray
66    
67     After installing the software, you may want to start by scanning the
68     troff input documentation contained in "doc/ray.1", which is also formatted
69     for web browsers in "doc/ray.html".
70     A PDF version of this manual may be found in
71     "doc/pdf/ray.pdf", along with an older tutorial by Cindy Larson,
72     "doc/pdf/raduser1_6.pdf".
73    
74     For complete documentation on the system as of release 3.1, refer to
75     "Rendering with Radiance" by Larson and Shakespeare, which used to be
76     available from Morgan Kauffman Publishing. Unfortunately, the book has
77     gone out of print, and the authors are currently looking at alternative
78     means of distribution. The first chapter of this book, which includes
79     a basic tutorial and serves as a good introduction for new users, may be
80     found in "doc/pdf/RwR01.pdf". Keep tuned to the radiance website
81     for updates on the full book's availability.
82    
83     Important additions since version 3.1 include the holodeck programs (rholo,
84     etc., built in src/hd), glrad, ranimove, and the new "mesh" primitive,
85     suported by obj2mesh.
86    
87     Individual manual pages may be found in the subdirectory "doc/man".
88     You may want to copy these to the system manual directory, or add this
89     directory to your MANPATH environment variable in your shell
90     initialization file. A good starting place is to print the text file
91     ray/doc/man/whatis, which gives a one line description of each program in
92     the Radiance package. To print out the manual pages, use the "-man"
93     macro package.
94    
95     The most important program to learn about if you are a new user of Radiance
96     (or have not used this program before) is "rad". It controls Radiance
97     lighting parameters, and automates much of the rendering process.
98     To get started, change directory to obj/misc and try running:
99    
100     % rad -o x11 daf.rif
101    
102     This works if you are running X11. If you are not, you can still generate
103     an image with:
104    
105     % rad daf.rif &
106    
107     When the picture is done, you can convert it to another format for display
108     with any of the ra_* programs listed in the doc/whatis database.
109    
110     There is a user interface built on top of this using Tcl/Tk, called trad.
111     If you do not have Tcl/Tk installed on your system, you must do so prior
112     to building this distribution if you ant trad to install. (Try a google
113     search on "Tcl/Tk" or go to "http://www.scriptics.com/software/tcltk/".)
114    
115     If you have a question, you might start by looking in the Radiance Digest
116     archives, accessible from the Radiance web site. For current issues and
117     problems with this release, go to the radiance-online list at:
118    
119     http://www.radiance-online.org
120    
121     ----------------------------------------------------------------------
122     The Radiance Software License, Version 1.0
123    
124     Copyright (c) 1990 - 2002 The Regents of the University of California,
125     through Lawrence Berkeley National Laboratory. All rights reserved.
126    
127     Redistribution and use in source and binary forms, with or without
128     modification, are permitted provided that the following conditions
129     are met:
130    
131     1. Redistributions of source code must retain the above copyright
132     notice, this list of conditions and the following disclaimer.
133    
134     2. Redistributions in binary form must reproduce the above copyright
135     notice, this list of conditions and the following disclaimer in
136     the documentation and/or other materials provided with the
137     distribution.
138    
139     3. The end-user documentation included with the redistribution,
140     if any, must include the following acknowledgment:
141     "This product includes Radiance software
142     (http://radsite.lbl.gov/)
143     developed by the Lawrence Berkeley National Laboratory
144     (http://www.lbl.gov/)."
145     Alternately, this acknowledgment may appear in the software itself,
146     if and wherever such third-party acknowledgments normally appear.
147    
148     4. The names "Radiance," "Lawrence Berkeley National Laboratory"
149     and "The Regents of the University of California" must
150     not be used to endorse or promote products derived from this
151     software without prior written permission. For written
152     permission, please contact [email protected].
153    
154     5. Products derived from this software may not be called "Radiance",
155     nor may "Radiance" appear in their name, without prior written
156     permission of Lawrence Berkeley National Laboratory.
157    
158     THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
159     WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
160     OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
161     DISCLAIMED. IN NO EVENT SHALL Lawrence Berkeley National Laboratory OR
162     ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
163     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
164     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
165     USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
166     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
167     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
168     OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
169     SUCH DAMAGE.
170     ====================================================================
171    
172     This software consists of voluntary contributions made by many
173     individuals on behalf of Lawrence Berkeley National Laboratory. For more
174     information on Lawrence Berkeley National Laboratory, please see
175     <http://www.lbl.gov/>.
176