-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the README.md with site_specific.mk info and other tweaks
git-svn-id: file:///home/users/tmap/svn/repos/ferret/trunk@26200 fdbf22ae-c210-0410-be80-ca943da6b8f8
- Loading branch information
1 parent
c7d8e8c
commit 6213435
Showing
1 changed file
with
34 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,48 @@ | ||
# Ferret | ||
The Ferret program from NOAA/PMEL. | ||
This repository is regularly synchronized with Ferret repository at PMEL | ||
(the trunk of the ferret project in the subversion repository at PMEL) | ||
The Ferret program from NOAA/PMEL. | ||
See [https://ferret.pmel.noaa.gov/Ferret/](https://ferret.pmel.noaa.gov/Ferret/) | ||
for more information about Ferret and PyFerret. | ||
|
||
This repository is regularly synchronized with Ferret repository at PMEL | ||
(the trunk of the ferret project in the subversion repository at PMEL) | ||
using git-svn. | ||
|
||
#### Legal Disclaimer | ||
*This repository is a software product and is not official communication | ||
of the National Oceanic and Atmospheric Administration (NOAA), or the | ||
United States Department of Commerce (DOC). All NOAA GitHub project | ||
code is provided on an 'as is' basis and the user assumes responsibility | ||
for its use. Any claims against the DOC or DOC bureaus stemming from | ||
the use of this GitHub project will be governed by all applicable Federal | ||
law. Any reference to specific commercial products, processes, or services | ||
by service mark, trademark, manufacturer, or otherwise, does not constitute | ||
or imply their endorsement, recommendation, or favoring by the DOC. | ||
The DOC seal and logo, or the seal and logo of a DOC bureau, shall not | ||
be used in any manner to imply endorsement of any commercial product | ||
*This repository is a software product and is not official communication | ||
of the National Oceanic and Atmospheric Administration (NOAA), or the | ||
United States Department of Commerce (DOC). All NOAA GitHub project | ||
code is provided on an 'as is' basis and the user assumes responsibility | ||
for its use. Any claims against the DOC or DOC bureaus stemming from | ||
the use of this GitHub project will be governed by all applicable Federal | ||
law. Any reference to specific commercial products, processes, or services | ||
by service mark, trademark, manufacturer, or otherwise, does not constitute | ||
or imply their endorsement, recommendation, or favoring by the DOC. | ||
The DOC seal and logo, or the seal and logo of a DOC bureau, shall not | ||
be used in any manner to imply endorsement of any commercial product | ||
or activity by the DOC or the United States Government.* | ||
|
||
## Ferret Documentation | ||
|
||
For more information on using Ferret, see the Ferret documentation under | ||
[http://ferret.pmel.noaa.gov/Ferret/](http://ferret.pmel.noaa.gov/Ferret/) | ||
For more information on using Ferret, see the Ferret documentation under | ||
[https://ferret.pmel.noaa.gov/Ferret/](https://ferret.pmel.noaa.gov/Ferret/) | ||
|
||
Information about the Ferret email users group, and archives of past discussions | ||
from the group (which should be searched prior to sending a question to the email | ||
users group) can be found at | ||
[http://ferret.pmel.noaa.gov/Ferret/email-users-group](http://ferret.pmel.noaa.gov/Ferret/email-users-group) | ||
from the group (which should be searched prior to sending a question to the email | ||
users group) can be found at | ||
[https://ferret.pmel.noaa.gov/Ferret/email-users-group](https://ferret.pmel.noaa.gov/Ferret/email-users-group) | ||
|
||
## If you build Ferret from these source files, please note: | ||
|
||
The `site_specific.mk` and `external_functions/ef_utilites/site_specific.mk` | ||
files in the repository have been renamed with a `.in` appended to the name. | ||
You must copy these files with the `.in` extensions to create files with the | ||
`site_specific.mk` name and edit the contents to configure these for your | ||
system. The `site_specific.mk` files will be ignored by git (the name was | ||
added to `.gitignore`) so your customized configuration files will not be | ||
added to your repository if you have cloned this repository. | ||
|
||
#### The `site_specific.mk.in` configuration template file changed April, 2018. | ||
|
||
Library directories are now specified instead of installation directories | ||
for NetCDF, HDF5, ReadLine, and SZ, with the makefile environment names | ||
changing from `..._DIR` to `..._LIBDIR`. | ||
The `include` directories, if needed, are assumed to be sibling directories | ||
to these library directories. | ||
You may wish to create a new `site_specific.mk` configuration file | ||
from this updated configuration template file. | ||
The `site_specific.mk.in` and `external_functions/ef_utilites/site_specific.mk.in` | ||
files in the repository must be copied to files without the `.in` extensions, and | ||
the contents of these `site_specific.mk` files edited for your system configuration. | ||
The `site_specific.mk` files will be ignored by git (the name was added to | ||
`.gitignore`) so your customized configuration files will not be added to your | ||
repository if you have cloned this repository. | ||
|
||
The definitions of CC, FC, and LD (the last only for building external | ||
functions written in Fortran) were moved to the `site_specific.mk.in` files. | ||
(These were previously defined in the `platform_specific.mk.*` files.) | ||
If you already have customized `site_specific.mk` files, please appropriately | ||
updated your customized files with these additional definitions. | ||
|