Skip to content

Commit 9c10f84

Browse files
author
ansley
committed
add information about *make install*
git-svn-id: file:///home/users/tmap/svn/repos/ferret/trunk@12970 fdbf22ae-c210-0410-be80-ca943da6b8f8
1 parent 8a4d3e1 commit 9c10f84

File tree

1 file changed

+49
-26
lines changed

1 file changed

+49
-26
lines changed

README_build_ferret

Lines changed: 49 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,66 @@
1-
As of August 2011 we now have a single make procedure for compiling and linking Ferret.
1+
As of August 2011 we now have a single make procedure for compiling, linking, and
2+
installing Ferret.
23

34

4-
NetCDF4.1 or higher is required for building Ferret. The library netcdf4.2 or higher
5-
is recommended. For building the libraries and Ferret, we have used
6-
gfortran. The netcdf downloads can be found here: http://www.unidata.ucar.edu/software/netcdf/.
7-
Build netcdf4.+ with the appropriate vesion of hdf5 given in the netCDF instructions; and with
8-
--enable-fortran in the configuration. Specify the hdf5 libraries, --enable-netcdf-4
9-
--enable-dap for for netcdf-4 features and OPeNDAP dataset access.
5+
NetCDF4.1 or higher is required for building Ferret. The library NetCDF4.2 or higher
6+
is recommended. We recommend building NetCDF and HDF libraries yourself, so that these
7+
libraries and Ferret are all built with the same compiler. This takes a little time, but
8+
is not difficult. For building the libraries and Ferret, we have used gfortran. The
9+
NetCDF downloads can be found here: http://www.unidata.ucar.edu/software/NetCDF/. Build
10+
NetCDF4.+ with the appropriate version of hdf5 given in the NetCDF instructions; and make
11+
sure to build it with fortran (Starting with NetCDF4.1.3 there is a separate NetCDF fortran
12+
library). Specify the hdf5 libraries, --enable-NetCDF-4 --enable-dap for NetCDF-4 features
13+
and OPeNDAP dataset access.
1014

11-
The current official release of Ferret is linked with netcdf4.2 and has syntax for
12-
writing netcdf4 datasets (hdf5 chunking and compression.) See the release notes
15+
The current official release of Ferret is linked with NetCDF4.2 and has syntax for
16+
writing NetCDF4 datasets (hdf5 chunking and compression.) See the release notes
1317
for Ferret v6.6 at http://porter.pmel.noaa.gov/Ferret/home/documentation/v6-6-release-notes
1418

1519

1620
To build Ferret:
1721

18-
* Under the FERRET directory you will find a file called site_specifid.mk. Edit this file
19-
and insert the locations of the HDF5, NetCDF, and readline directories, and java. Java is
20-
used only for the ThreddsBrowser facility of Ferret and is not required.
22+
* Under the FERRET directory you will find a file called site_specific.mk. Edit this file
23+
and insert the locations of the HDF5, NetCDF, and readline directories, and java. Java is
24+
used only for the ThreddsBrowser facility of Ferret and is not required. If you use Java,
25+
you need version 1.6 "version 6".
2126

2227
* Still in the top-level FERRET directory, run "make". This will compile and link Ferret,
23-
gksm2ps, external functions, and the fonts files. The Ferret executable is the file
28+
gksm2ps, external functions, and the fonts files. The Ferret executable is the file
2429
FERRET/fer/ferret_c
25-
2630

27-
* as it finishes, you will see a line similar to
31+
* The build process creates the fonts files that will be needed for Ferret.
2832

29-
make[1]: Leaving directory '/home/users/ansley/linux/FERRET/bin/build_fonts/unix'
30-
31-
Take note of this directory.
33+
* In the site_specific.mk file, you will see a section about the variable INSTALL_FER_DIR.
34+
It is defined there as INSTALL_FER_DIR = $(FER_DIR). If you leave it set that way, then run
35+
"make install" to install Ferret and the environment under that directory. It will also
36+
create the tar files fer_environment.tar.gz and fer_executables.tar.gz in directory $(FER_DIR).
37+
38+
Alternatively you may want to set INSTALL_FER_DIR to some local directory. Now run "make
39+
install". This will install Ferret under the directory you defined and also create
40+
fer_environment.tar.gz and fer_executables.tar.gz as if they came from the Ferret
41+
distribution. Now you can get the Datasets tar file from
42+
ftp://ftp.pmel.noaa.gov/ferret/pub/data/fer_dsets.tar.gz
43+
and follow the installation instructions
44+
http://ferret.pmel.noaa.gov/static/Downloads/ferret_installation_and_update_guide_v600.html
3245

46+
* Once you have installed Ferret, you'll want to test it. Running some simple scripts,
47+
such as "yes? go ptest" is a good place to start. If you wish, go into the FERRET/bench
48+
directory to run the suite of benchmark tests. There is a simple README file which will
49+
get you started with running the Ferret benchmark scripts. You will run a shell script
50+
called "run_all" which starts the benchmark job. It tests a wide variety of Ferret's
51+
capabilities and makes a number of plots. If it runs successfully you will see these lines:
3352

34-
* Get the environment and datasets tar files for one of our linux versions. You will need the
35-
go scripts, and palette files. See the bin/Finstall script and the Ferret installation instructions
36-
for details about setting up the environment to run Ferret. You could run Finstall as described
37-
in the installation instructions, but replace the binary file "ferret_vxx" with the executable
38-
you have built, and bin/ppl/fonts/ with the fonts files in .../FERRET/bin/build_fonts/unix.
53+
about to run test of .ferret script
54+
Display no longer set, about to run batch gif test
55+
Display still not set, about to run batch ps test
56+
Display still not set, about to run batch metafile test
57+
Ended at Tue Nov 8 13:08:13 PST 2011
58+
Checking PLT, GIF and PS files.......
3959

40-
* Once you have an executable, go into the FERRET/bench directory to run tests. There is a
41-
simple README file which will get you started with running the Ferret benchmark scripts.
42-
You will run a shell script called "run_all" which starts the benchmark job.
60+
In all likelihood this will be followed by a number of messages starting with "plt files
61+
differ". The script checks the size of the image files, and it's to be expected that that
62+
will differ a bit from one system to another.
4363

64+
Running all the way through the benchmark suite is a good test of Ferret and the Ferret
65+
installation. If you have questions about the results you are welcome to write us at the
66+
contact-Ferret email address, see http://ferret.pmel.noaa.gov/Ferret/support.

0 commit comments

Comments
 (0)