Skip to content

Commit e5193be

Browse files
committed
Modify README_build_ferret to include copy site_specific.mk.in to site_specific.mk and update some info and references
git-svn-id: file:///home/users/tmap/svn/repos/ferret/trunk@25257 fdbf22ae-c210-0410-be80-ca943da6b8f8
1 parent 57e4eec commit e5193be

File tree

1 file changed

+29
-26
lines changed

1 file changed

+29
-26
lines changed

README_build_ferret

+29-26
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,54 @@
1-
As of August 2011 we now have a single make procedure for compiling, linking, and
2-
installing Ferret.
1+
As of August 2011 we now have a single make procedure for compiling, linking, and
2+
installing Ferret.
33

44

55
NetCDF4.1 or higher is required for building Ferret. The library NetCDF4.2 or higher
66
is recommended. We recommend building NetCDF and HDF libraries yourself, so that these
77
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
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
1010
NetCDF4.+ with the appropriate version of hdf5 given in the NetCDF instructions; and make
1111
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
12+
library). Specify the hdf5 libraries, --enable-NetCDF-4 --enable-dap for NetCDF-4 features
1313
and OPeNDAP dataset access.
1414

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
17-
for Ferret v6.6 at http://porter.pmel.noaa.gov/Ferret/home/documentation/v6-6-release-notes
15+
The current official release of Ferret is linked with NetCDF4.4.1 and has syntax for
16+
writing NetCDF4 datasets (hdf5 chunking and compression.)
1817

1918

2019
To build Ferret:
2120

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.
21+
* Under the FERRET directory you will find a file called "site_specific.mk.in".
22+
Copy this file to "site_specific.mk" and edit this copy of the file,
23+
inserting the locations of the HDF5, NetCDF, and readline directories.
24+
Similarily, in the "external_functions/ef_utility/" subdirectory of the FERRET directory
25+
is another "site_specific.mk.in" file that should be copied to "site_specific.mk"
26+
in that directory and edited to provide appropriate values.
2427

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

2932
* The build process creates the fonts files that will be needed for Ferret.
3033

3134
* In the site_specific.mk file, you will see a section about the variable INSTALL_FER_DIR.
32-
It is defined there as INSTALL_FER_DIR = $(FER_DIR). If you leave it set that way, then run
35+
It is defined there as INSTALL_FER_DIR = $(FER_DIR). If you leave it set that way, then run
3336
"make install" to install Ferret and the environment under that directory. It will also
3437
create the tar files fer_environment.tar.gz and fer_executables.tar.gz in directory $(FER_DIR).
35-
36-
Alternatively you may want to set INSTALL_FER_DIR to some local directory. Now run "make
37-
install". This will install Ferret under the directory you defined and also create
38-
fer_environment.tar.gz and fer_executables.tar.gz as if they came from the Ferret
39-
distribution. Now you can get the Datasets tar file from
40-
ftp://ftp.pmel.noaa.gov/ferret/pub/data/fer_dsets.tar.gz
41-
and follow the installation instructions
42-
http://ferret.pmel.noaa.gov/static/Downloads/ferret_installation_and_update_guide_v600.html
4338

44-
* Once you have installed Ferret, you'll want to test it. Running some simple scripts,
45-
such as "yes? go ptest" is a good place to start. If you wish, go into the FERRET/bench
46-
directory to run the suite of benchmark tests. There is a simple README file which will
47-
get you started with running the Ferret benchmark scripts. You will run a shell script
48-
called "run_all" which starts the benchmark job. It tests a wide variety of Ferret's
39+
Alternatively you may want to set INSTALL_FER_DIR to some other directory. Now run
40+
"make install". This will install Ferret under the directory you defined and also
41+
create fer_environment.tar.gz and fer_executables.tar.gz as if they came from the
42+
Ferret distribution. Now you can get the Datasets tar file from
43+
https://github.com/NOAA-PMEL/FerretDatasets
44+
which is needed to complete the installation by running the "bin/Finstall" script
45+
in the FERRET directory and selecting option 2 (generate the ferret_paths scripts).
46+
47+
* Once you have installed Ferret, you'll want to test it. Running some simple scripts,
48+
such as "yes? go ptest" is a good place to start. If you wish, go into the FERRET/bench
49+
directory to run the suite of benchmark tests. There is a simple README file which will
50+
get you started with running the Ferret benchmark scripts. You will run a shell script
51+
called "run_all" which starts the benchmark job. It tests a wide variety of Ferret's
4952
capabilities and makes a number of plots. If it runs successfully you will see these lines:
5053

5154
about to run test of .ferret script
@@ -60,5 +63,5 @@ Checking PLT, GIF and PS files.......
6063
will differ a bit from one system to another.
6164

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

0 commit comments

Comments
 (0)