diff --git a/README.md b/README.md index 273287bea..35b14a484 100644 --- a/README.md +++ b/README.md @@ -34,49 +34,60 @@ formats. For information about a variety of analysis and display packages that have been developed to analyze and display data in netCDF form, see -* http://www.unidata.ucar.edu/netcdf/software.html +* [Software for Manipulating or Displaying NetCDF Data](http://www.unidata.ucar.edu/netcdf/software.html) -##### More informations -For more information about netCDF, see the netCDF Web page at +##### More information +For more information about netCDF, see -* http://www.unidata.ucar.edu/netcdf/ +* [Unidata Network Common Data Form (NetCDF)](http://www.unidata.ucar.edu/netcdf/) ### Latest releases -You can obtain a copy of the latest released version of netCDF software -from +You can obtain a copy of the latest released version of netCDF +software for various languages: -* C - http://github.com/Unidata/netcdf-c -* Fortan - http://github.com/Unidata/netcdf-fortran -* Libraries and utilities in C - http://github.com/Unidata/netcdf-cxx4 -* Python - http://github.com/Unidata/netcdf4-python +* [C library and utilities](http://github.com/Unidata/netcdf-c) +* [Fortran](http://github.com/Unidata/netcdf-fortran) +* [Java](http://www.unidata.ucar.edu/downloads/netcdf/netcdf-java-4/) +* [Python](http://github.com/Unidata/netcdf4-python) +* [C++](http://github.com/Unidata/netcdf-cxx4) ### Copyright -Copyright and licensing information can be found here, as well as in -the COPYRIGHT file accompanying the software +Copyright and licensing information can be found +[here](http://www.unidata.ucar.edu/software/netcdf/copyright.html), as +well as in the COPYRIGHT file accompanying the software -* http://www.unidata.ucar.edu/software/netcdf/copyright.html +### Installation +To install the netCDF-C software, please see the file INSTALL in the +netCDF-C distribution, or the (usually more up-to-date) document: -### Install -To install this package, please see the file INSTALL in the -distribution, or the (usually more up-to-date) document: +* [Building NetCDF](http://www.unidata.ucar.edu/netcdf/docs/building.html) -* http://www.unidata.ucar.edu/netcdf/docs/building.html +### Documentation +Reference documentation for various language interfaces are available from: -The netCDF-3 C and FORTRAN-77 interfaces are documented in man(1) -pages at +* [NetCDF-C](http://www.unidata.ucar.edu/netcdf/docs/modules.html), + [C man page](http://www.unidata.ucar.edu/netcdf/docs/netcdf-man-3.html) +* [Fortran-90](http://www.unidata.ucar.edu/netcdf/docs/netcdf-f90.html) +* [Fortran-77](http://www.unidata.ucar.edu/netcdf/docs/netcdf-man-3f.html) +* [Java](http://www.unidata.ucar.edu/software/thredds/current/netcdf-java/reference/) +* [C++](https://www.unidata.ucar.edu/netcdf/docs/cxx4/index.html) +* [Python](http://unidata.github.io/netcdf4-python/#header-classes) -* http://www.unidata.ucar.edu/netcdf/docs/netcdf-man-3.html -* http://www.unidata.ucar.edu/netcdf/docs/netcdf-man-3f.html +A language-independent User's Guide for netCDF, and some other +language-specific documents are available from: -### User's Guides -User's Guides are also available in several forms from the same -location. +* [Language-independent User's Guide](http://www.unidata.ucar.edu/netcdf/docs/user_guide.html) +* [NetCDF-C Tutorial](http://www.unidata.ucar.edu/software/netcdf/docs/tutorial_8dox.html) +* [Fortran-90 User's Guide](http://www.unidata.ucar.edu/netcdf/docs/netcdf-f90.html) +* [Fortran-77 User's Guide](http://www.unidata.ucar.edu/netcdf/docs/netcdf-f77.html) +* [netCDF-Java/Common Data Model library](http://www.unidata.ucar.edu/software/thredds/current/netcdf-java/) +* [netCDF4-python](http://unidata.github.io/netcdf4-python/) A mailing list, netcdfgroup@unidata.ucar.edu, exists for discussion of the netCDF interface and announcements about netCDF bugs, fixes, and enhancements. For information about how to subscribe, see the URL -* http://www.unidata.ucar.edu/netcdf/mailing-lists.html +* [Unidata netCDF Mailing-Lists](http://www.unidata.ucar.edu/netcdf/mailing-lists.html) ### Feedback We appreciate feedback from users of this package. Please send diff --git a/docs/FAQ.md b/docs/FAQ.md index f42b8a340..0b35e48b7 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -241,9 +241,6 @@ A primary reference is the User's Guide: Rew, R. K., G. P. Davis, S. Emmerson, and H. Davies, **NetCDF User's Guide for C, An Interface for Data Access, Version 3**, April 1997. -To cite use of netCDF software, please use this Digital Object Identifier (DOI): -[http://dx.doi.org/10.5065/D6H70CW6](http://dx.doi.org/10.5065/D6H70CW6) - Current online and downloadable documentation is available from the [documentation directory](http://www.unidata.ucar.edu/software/netcdf/docs/). @@ -280,6 +277,21 @@ Rew, R. K. and G. P. Davis, " [Unidata's netCDF Interface for Data Access: Statu ---------- +I'm submitting a paper for publication and want to include a citation for use of netCDF software. What reference should I use? {#How-should-I-cite-use-of-netCDF-software} +----------------- + +The registered Digital Object Identifier for all versions of netCDF software is `http://doi.org/10.5065/D6H70CW6`. + +The following can be used as a citation: + +Unidata, (_year_): Network Common Data Form (netCDF) version _nc_version_ [software]. Boulder, CO: UCAR/Unidata. (http://doi.org/10.5065/D6H70CW6) + +where _year_ is the year in which the work being described was done and _nc_version_ is the version of netCDF used. For example: + +Unidata, (2015): Network Common Data Form (netCDF) version 4.3.3.1 [software]. Boulder, CO: UCAR/Unidata. (http://doi.org/10.5065/D6H70CW6) + +---------- + Is there a document describing the actual physical format for a Unidata netCDF file? {#Is-there-a-document-describing-the-actual-physical-format-for-a-Unidata-netCDF-file} -----------------