viewcvs.cgi/ray/README

                RCSid "$Id"

Hello and welcome to the Radiance synthetic imaging system.  This is
the thirteenth release, Version 3.6, and it includes all source files
for local compilation with a standard C compiler.  To find out what's
new in this release, check the text file "doc/notes/ReleaseNotes".

Radiance is OpenSource software copyrighted and distributed by
Lawrence Berkeley National Laboratory in California.  By downloading
and installing this software, you are implicitly agreeing to the
OpenSource license appended to this README file.  Please read it
carefully before proceeding -- this is very different from previous
licenses, and contains fewer restrictions on commercialization.

Please read this entire file before sending e-mail asking
how to install this software or what to do with it.  Some
frequently asked questions are answered here and also on our
web site at:

        http://radsite.lbl.gov/radiance/

The website above should also have some precompiled Radiance binaries
and add-ons for common Unix platforms.

We have attempted to make it easy for you (and for us) to install
the software on differently configured systems using a global make
script.  To install the software, just type:

        ./makeall install

You can clean up the .o files and so forth with:

        ./makeall clean

Or, if you are confident you can do both at the same time with:

        ./makeall install clean

You can give other make options at the end of the command as well.  For
example, the -n option will tell you what makeall is going to do without
actually doing it.

If you downloaded the binaries, so compilation is not necessary,
run the following command to install the library files only:

        ./makeall library

The makeall may script ask you questions about your system and where you
want to install the executables and library files.  The pathnames you
give should be relative to root for the programs to work properly.  You
may also use the tilde ('~') character to give paths starting with
someone's home directory.

If you do NOT have X11 support, please read the note "noX11.help" in
this directory.  It explains what to change to make things work.

Although it is set automatically by makeall, individuals may want to
set the RAYPATH environment variable manually.  This variable tells
Radiance where to look for auxiliary files, and usually includes the
current directory as well as the system library (ray/lib in this
distribution).  As you develop auxiliary files yourself, it is often
useful to add in your own library directory before the system directory.
An example setting such as this would go in a user's .login file:

        setenv RAYPATH .:${HOME}/mylib:/usr/local/lib/ray

After installing the software, you may want to start by scanning the
troff input documentation contained in "doc/ray.1", which is also formatted
for web browsers in "doc/ray.html".
A PDF version of this manual may be found in
"doc/pdf/ray.pdf", along with an older tutorial by Cindy Larson,
"doc/pdf/raduser1_6.pdf".

For complete documentation on the system as of release 3.1, refer to
"Rendering with Radiance" by Larson and Shakespeare, which used to be
available from Morgan Kauffman Publishing.  Recently, the authors have
taken over printing of the book, which is now available from booksurge.com.
You may find it linked to the Radiance website page:

        http://radsite.lbl.gov/radiance/book/

The first chapter of this book, which includes a basic tutorial and
serves as a good introduction for new users, may be found in
"doc/pdf/RwR01.pdf".

Important additions since version 3.1 include the holodeck programs (rholo,
etc., built in src/hd), glrad, ranimove, and the new "mesh" primitive,
suported by obj2mesh.

Individual manual pages may be found in the subdirectory "doc/man".
You may want to copy these to the system manual directory, or add this
directory to your MANPATH environment variable in your shell
initialization file.  A good starting place is to print the text file
ray/doc/man/whatis, which gives a one line description of each program in
the Radiance package.  To print out the manual pages, use the "-man"
macro package.

The most important program to learn about if you are a new user of Radiance
(or have not used this program before) is "rad".  It controls Radiance
lighting parameters, and automates much of the rendering process.
To get started, change directory to obj/misc and try running:

        % rad -o x11 daf.rif

This works if you are running X11.  If you are not, you can still generate
an image with:

        % rad daf.rif &

When the picture is done, you can convert it to another format for display
with any of the ra_* programs listed in the doc/whatis database.

There is a user interface built on top of this using Tcl/Tk, called trad.
If you do not have Tcl/Tk installed on your system, you must do so prior
to building this distribution if you ant trad to install.  (Try a google
search on "Tcl/Tk" or go to "http://www.scriptics.com/software/tcltk/".)

If you have a question, you might start by looking in the Radiance Digest
archives, accessible from the Radiance web site.  For current issues and
problems with this release, go to the radiance-online list at:

        http://www.radiance-online.org

----------------------------------------------------------------------
The Radiance Software License, Version 1.0

Copyright (c) 1990 - 2002 The Regents of the University of California,
through Lawrence Berkeley National Laboratory.   All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.

3. The end-user documentation included with the redistribution,
          if any, must include the following acknowledgment:
            "This product includes Radiance software
                (http://radsite.lbl.gov/)
                developed by the Lawrence Berkeley National Laboratory
              (http://www.lbl.gov/)."
      Alternately, this acknowledgment may appear in the software itself,
      if and wherever such third-party acknowledgments normally appear.

4. The names "Radiance," "Lawrence Berkeley National Laboratory"
      and "The Regents of the University of California" must
      not be used to endorse or promote products derived from this
      software without prior written permission. For written
      permission, please contact [email protected].

5. Products derived from this software may not be called "Radiance",
      nor may "Radiance" appear in their name, without prior written
      permission of Lawrence Berkeley National Laboratory.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED.   IN NO EVENT SHALL Lawrence Berkeley National Laboratory OR
ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
====================================================================

This software consists of voluntary contributions made by many
individuals on behalf of Lawrence Berkeley National Laboratory.   For more
information on Lawrence Berkeley National Laboratory, please see
<http://www.lbl.gov/>.

Revision:	1.3
Committed:	Sun Aug 1 13:24:38 2004 UTC (19 years, 8 months ago) by greg
Branch:	MAIN
Changes since 1.2:	+10 -7 lines
Log Message:	Added mention of renewed book availability (RwR)
#	Content
1	RCSid "$Id"
2
3	Hello and welcome to the Radiance synthetic imaging system. This is
4	the thirteenth release, Version 3.6, 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	./makeall install
30
31	You can clean up the .o files and so forth with:
32
33	./makeall clean
34
35	Or, if you are confident you can do both at the same time with:
36
37	./makeall install clean
38
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	./makeall library
47
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. Recently, the authors have
77	taken over printing of the book, which is now available from booksurge.com.
78	You may find it linked to the Radiance website page:
79
80	http://radsite.lbl.gov/radiance/book/
81
82	The first chapter of this book, which includes a basic tutorial and
83	serves as a good introduction for new users, may be found in
84	"doc/pdf/RwR01.pdf".
85
86	Important additions since version 3.1 include the holodeck programs (rholo,
87	etc., built in src/hd), glrad, ranimove, and the new "mesh" primitive,
88	suported by obj2mesh.
89
90	Individual manual pages may be found in the subdirectory "doc/man".
91	You may want to copy these to the system manual directory, or add this
92	directory to your MANPATH environment variable in your shell
93	initialization file. A good starting place is to print the text file
94	ray/doc/man/whatis, which gives a one line description of each program in
95	the Radiance package. To print out the manual pages, use the "-man"
96	macro package.
97
98	The most important program to learn about if you are a new user of Radiance
99	(or have not used this program before) is "rad". It controls Radiance
100	lighting parameters, and automates much of the rendering process.
101	To get started, change directory to obj/misc and try running:
102
103	% rad -o x11 daf.rif
104
105	This works if you are running X11. If you are not, you can still generate
106	an image with:
107
108	% rad daf.rif &
109
110	When the picture is done, you can convert it to another format for display
111	with any of the ra_* programs listed in the doc/whatis database.
112
113	There is a user interface built on top of this using Tcl/Tk, called trad.
114	If you do not have Tcl/Tk installed on your system, you must do so prior
115	to building this distribution if you ant trad to install. (Try a google
116	search on "Tcl/Tk" or go to "http://www.scriptics.com/software/tcltk/".)
117
118	If you have a question, you might start by looking in the Radiance Digest
119	archives, accessible from the Radiance web site. For current issues and
120	problems with this release, go to the radiance-online list at:
121
122	http://www.radiance-online.org
123
124	----------------------------------------------------------------------
125	The Radiance Software License, Version 1.0
126
127	Copyright (c) 1990 - 2002 The Regents of the University of California,
128	through Lawrence Berkeley National Laboratory. All rights reserved.
129
130	Redistribution and use in source and binary forms, with or without
131	modification, are permitted provided that the following conditions
132	are met:
133
134	1. Redistributions of source code must retain the above copyright
135	notice, this list of conditions and the following disclaimer.
136
137	2. Redistributions in binary form must reproduce the above copyright
138	notice, this list of conditions and the following disclaimer in
139	the documentation and/or other materials provided with the
140	distribution.
141
142	3. The end-user documentation included with the redistribution,
143	if any, must include the following acknowledgment:
144	"This product includes Radiance software
145	(http://radsite.lbl.gov/)
146	developed by the Lawrence Berkeley National Laboratory
147	(http://www.lbl.gov/)."
148	Alternately, this acknowledgment may appear in the software itself,
149	if and wherever such third-party acknowledgments normally appear.
150
151	4. The names "Radiance," "Lawrence Berkeley National Laboratory"
152	and "The Regents of the University of California" must
153	not be used to endorse or promote products derived from this
154	software without prior written permission. For written
155	permission, please contact [email protected].
156
157	5. Products derived from this software may not be called "Radiance",
158	nor may "Radiance" appear in their name, without prior written
159	permission of Lawrence Berkeley National Laboratory.
160
161	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
162	WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
163	OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
164	DISCLAIMED. IN NO EVENT SHALL Lawrence Berkeley National Laboratory OR
165	ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
166	SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
167	LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
168	USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
169	ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
170	OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
171	OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
172	SUCH DAMAGE.
173	====================================================================
174
175	This software consists of voluntary contributions made by many
176	individuals on behalf of Lawrence Berkeley National Laboratory. For more
177	information on Lawrence Berkeley National Laboratory, please see
178	<http://www.lbl.gov/>.
179