1 |
RCSid "$Id: README.txt,v 1.7 2020/09/03 15:46:32 greg Exp $" |
2 |
|
3 |
Hello and welcome to the Radiance synthetic imaging system. This is |
4 |
the twenty-fifth release, Version 5.4, 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 open source 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 |
copyright appended to this README file, and the license agreement (License.txt) |
12 |
in the same directory. Please read both carefully before proceeding. |
13 |
|
14 |
Please read this entire file before sending e-mail asking |
15 |
how to install this software or what to do with it. Some |
16 |
frequently asked questions are answered here and also on our |
17 |
website at: |
18 |
|
19 |
https://www.radiance-online.org/ |
20 |
|
21 |
The CVS source tree is available, including post-release bug-fixes and |
22 |
mailing lists access at: |
23 |
|
24 |
https://www.radiance-online.org/download-install/CVS%20source%20code |
25 |
|
26 |
The website below has some precompiled Radiance binaries |
27 |
and add-ons for common Unix platforms: |
28 |
|
29 |
https://www.radiance-online.org/download-install/installation-information |
30 |
|
31 |
We have attempted to make it easy for you (and for us) to install |
32 |
the software on differently configured systems using a global make |
33 |
script. To install the software, just type: |
34 |
|
35 |
./makeall install |
36 |
|
37 |
You can clean up the .o files and so forth with: |
38 |
|
39 |
./makeall clean |
40 |
|
41 |
Or, if you are confident you can do both at the same time with: |
42 |
|
43 |
./makeall install clean |
44 |
|
45 |
You can give other make options at the end of the command as well. For |
46 |
example, the -n option will tell you what makeall is going to do without |
47 |
actually doing it. |
48 |
|
49 |
If you downloaded the binaries, so compilation is not necessary, |
50 |
run the following command to install the library files only: |
51 |
|
52 |
./makeall library |
53 |
|
54 |
The makeall script may ask you questions about your system and where you |
55 |
want to install the executables and library files. The pathnames you |
56 |
give should be relative to root for the programs to work properly. You |
57 |
may also use the tilde ('~') character to give paths starting with |
58 |
someone's home directory. |
59 |
|
60 |
If you do NOT have X11 support, please read the note "noX11.help" in |
61 |
this directory. It explains what to change to make things work. |
62 |
|
63 |
Although it is set automatically by makeall, individuals may want to |
64 |
set the RAYPATH environment variable manually. This variable tells |
65 |
Radiance where to look for auxiliary files, and usually includes the |
66 |
current directory as well as the system library (ray/lib in this |
67 |
distribution). As you develop auxiliary files yourself, it is often |
68 |
useful to add in your own library directory before the system directory. |
69 |
An example setting such as this would go in a user's .login file: |
70 |
|
71 |
setenv RAYPATH .:${HOME}/mylib:/usr/local/lib/ray |
72 |
|
73 |
After installing the software, you may want to start by scanning the |
74 |
troff input documentation contained in "doc/ray.1", which is also formatted |
75 |
for web browsers in "doc/ray.html". |
76 |
A PDF version of this manual may be found in |
77 |
"doc/pdf/ray.pdf", along with an older tutorial by Cindy Larson, |
78 |
"doc/pdf/raduser1_6.pdf". |
79 |
|
80 |
To check that everything is peforming correctly, you can run: |
81 |
|
82 |
./makeall test |
83 |
|
84 |
For complete documentation on the system as of release 3.1, refer to |
85 |
"Rendering with Radiance" by Larson and Shakespeare, which used to be |
86 |
available from Morgan Kauffman Publishing. Recently, the authors have |
87 |
taken over printing of the book, which is now available from booksurge.com. |
88 |
You may find it linked to the Radiance website page: |
89 |
|
90 |
http://radsite.lbl.gov/radiance/book/ |
91 |
|
92 |
The first chapter of this book, which includes a basic tutorial and |
93 |
serves as a good introduction for new users, may be found in |
94 |
"doc/pdf/RwR01.pdf". |
95 |
|
96 |
Important additions since version 3.1 include the holodeck programs (rholo, |
97 |
etc., built in src/hd), glrad, ranimove, the new "mesh" primitive, |
98 |
and rtcontrib. Again, check doc/notes/ReleaseNotes for details. |
99 |
|
100 |
Individual manual pages may be found in the subdirectory "doc/man". |
101 |
You may want to copy these to the system manual directory, or add this |
102 |
directory to your MANPATH environment variable in your shell |
103 |
initialization file. A good starting place is to print the text file |
104 |
ray/doc/man/whatis, which gives a one line description of each program in |
105 |
the Radiance package. To print out the manual pages, use the "-man" |
106 |
macro package. |
107 |
|
108 |
The most important program to learn about if you are a new user of Radiance |
109 |
(or have not used this program before) is "rad". It controls Radiance |
110 |
lighting parameters, and automates much of the rendering process. |
111 |
To get started, change directory to obj/misc and try running: |
112 |
|
113 |
% rad -o x11 daf.rif |
114 |
|
115 |
This works if you are running X11. If you are not, you can still generate |
116 |
an image with: |
117 |
|
118 |
% rad daf.rif & |
119 |
|
120 |
When the picture is done, you can convert it to another format for display |
121 |
with any of the ra_* programs listed in the doc/whatis database. |
122 |
|
123 |
There is a user interface built on top of this using Tcl/Tk, called trad. |
124 |
If you do not have Tcl/Tk installed on your system, you must do so prior |
125 |
to building this distribution if you want trad to install. (Try a google |
126 |
search on "Tcl/Tk" or go to "http://www.scriptics.com/software/tcltk/".) |
127 |
|
128 |
+++++++++++++++++ COPYRIGHT NOTICE +++++++++++++++++ |
129 |
|
130 |
Radiance v5.4 Copyright (c) 1990 to 2022, The Regents of the University of |
131 |
California, through Lawrence Berkeley National Laboratory (subject to receipt |
132 |
of any required approvals from the U.S. Dept. of Energy). All rights reserved. |
133 |
|
134 |
If you have questions about your rights to use or distribute this software, |
135 |
please contact Berkeley Lab's Intellectual Property Office at |
136 |
[email protected]. |
137 |
|
138 |
NOTICE. This Software was developed under funding from the U.S. Department |
139 |
of Energy and the U.S. Government consequently retains certain rights. As |
140 |
such, the U.S. Government has been granted for itself and others acting on |
141 |
its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the |
142 |
Software to reproduce, distribute copies to the public, prepare derivative |
143 |
works, and perform publicly and display publicly, and to permit others to do so. |
144 |
|