mirror/netcdf-c
2
0
Fork 0
mirror of https://github.com/Unidata/netcdf-c.git synced 2024-11-21 03:13:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

More reorganizing of the documentation generated by doxygen. Added a link to the main Unidata netcdf page to the footer, because we are going to turn off the header and footer on the web server. This should allow the Doxygen-generated search field to be properly placed.

Browse Source
This commit is contained in:
Ward Fisher 2014-02-26 14:22:35 -07:00
parent 74feb63e09
commit 034c1cad7c
6 changed files with 75 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
RELEASE_NOTES.md
View File

@ -1,8 +1,9 @@
Release Notes {#release_notes}
=============
\brief Historic Release Notes.
This file contains a high-level description of this package's evolution. Releases are in reverse chronological order (most recent first).
\brief Release notes file for the netcdf-c package.
This file contains a high-level description of this package's evolution. Releases are in reverse chronological order (most recent first). Note that, as of netcdf 4.2, the netcdf-c++ and netcdf-fortran libraries have been separated into their own libraries.
## 4.3.1.2 Released TBD
@ -28,7 +29,7 @@ This file contains a high-level description of this package's evolution. Release
## 4.3.1.1 Released 2014-02-05
4.3.1.1 Is a bug-fix for the 4.3.1 release.
This is a bug-fix-only release for version 4.3.1.
* Corrected a DAP issue reported by Jeff Whitaker related to non-conforming servers.
@ -40,6 +41,7 @@ This file contains a high-level description of this package's evolution. Release
[NCF-273]:https://bugtracking.unidata.ucar.edu/browse/NCF-273
### 4.3.1-rc6 Released 2013-12-19
* Fixed fill value handling for string types in nc4\_get\_vara().
@ -51,6 +53,7 @@ This file contains a high-level description of this package's evolution. Release
* A number of previously-disabled unit tests were reviewed and made active.
### 4.3.1-rc5 Released 2013-12-06
* When opening a netCDF-4 file, streamline the iteration over objects in the underlying HDF5 file.
@ -83,6 +86,7 @@ This file contains a high-level description of this package's evolution. Release
[NCF-275]:https://bugtracking.unidata.ucar.edu/browse/NCF-275
### 4.3.1-rc4 Released 2013-11-06
* Addressed an issue on Windows where `fstat` would report an incorrect file size on files > 4GB. [NCF-219]
@ -1596,4 +1600,4 @@ description of the evolution of the netCDF-3 package.
* A comparison of the netCDF-2 and netCDF-3 releases can be found in the
file COMPATIBILITY.
*/
*/

2
man4/Doxyfile.in
View File

@ -25,7 +25,7 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = netCDF
PROJECT_NAME = NetCDF
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or

9
man4/footer.html
View File

@ -1,4 +1,11 @@
<hr size="2"/><address style="text-align: right;"><small>
<hr size="2"/>
<address style="text-align: center;">
Return to the <a href="http://www.unidata.ucar.edu/software/netcdf/">Main Unidata NetCDF page.</a>
<address style="text-align: right;"><small>
Generated on $datetime for $projectname. NetCDF is
a <a href="http://www.unidata.ucar.edu/">Unidata</a> library.</small></address>
</body>

22
man4/install.dox
View File

@ -1,5 +1,6 @@
/*! \file
Documentation for getting and building netCDF
\brief Documentation for getting and building netCDF
This document is for getting and building the netCDF C library and
utilities, version 4.3.0. Other libraries that depend on the netCDF C
@ -9,11 +10,15 @@ library is successfully installed. The netCDF-Java library is also a
separate distribution that is currently independent of the netCDF C
library.
\page getting Getting NetCDF
\page getting_and_building_netcdf Getting and Building NetCDF-C
\brief This page provides instructions for obtaining and building NetCDF-C.
\tableofcontents
\section sec_get_pre_built Getting pre-built netCDF-C libraries.
\section getting Getting NetCDF
\subsection sec_get_pre_built Getting pre-built netCDF-C libraries.
The easiest way to get netCDF is through a package management program,
such as rpm, yum, adept, and others. NetCDF is available from many
@ -26,8 +31,7 @@ the netcdf.h header file.
\note If you are interested in building NetCDF-C on Windows, please see \ref winbin and \ref netCDF-CMake.
\section sec_get_source Getting the latest netCDF-C Source Code
\subsection sec_get_source Getting the latest netCDF-C Source Code
Starting with netCDF-C version 4.3.1, the netCDF-C source code is hosted at the
Unidata GitHub repository, available at http://github.com/Unidata/netcdf-c.
@ -37,7 +41,7 @@ Two options are available for building from source:
- The latest release.
- The developer snapshot.
\subsection sec_latest_release The latest release
\subsubsection sec_latest_release The latest release
The latest release may be downloaded from github at the following location:
@ -45,7 +49,7 @@ The latest release may be downloaded from github at the following location:
Source files are available in `.tar.gz` and `.zip` formats.
\subsection sec_dev_snapshot The developer snapshot
\subsubsection sec_dev_snapshot The developer snapshot
The developer snapshot may be cloned from github directly by using the `git` command.
@ -58,7 +62,7 @@ portability bugs.
Once you have downloaded and unpacked the distribution, see the
following section on \ref building.
\page building Building NetCDF
\section building Building NetCDF
The netCDF-C library and utilities require third-party libraries for
full functionality. (See \ref architecture).
@ -69,7 +73,7 @@ full functionality. (See \ref architecture).
- <a class="el" href="http://www.unidata.ucar.edu/netcdf/docs/netcdf-fortran-install.html" >Building netCDF-Fortran Libraries</a>
- \ref configure_options
\section sub CMake and Windows support
\subsection sub CMake and Windows support
- \ref netCDF-CMake
- \ref winbin

46
man4/mainpage.dox
View File

@ -6,13 +6,33 @@
\tableofcontents
\section NetCDF
\section mainpage_netcdf NetCDF
NetCDF is a set of software libraries and self-describing,
machine-independent data formats that support the creation, access,
and sharing of array-oriented scientific data. The NetCDF homepage may be found at <a href="http://www.unidata.ucar.edu/netcdf">http://www.unidata.ucar.edu/netcdf</a>. The NetCDF source-code is hosted at <a href="http://github.com">GitHub</a>, and may be found directly at <a href="http://github.com/Unidata/netcdf-c">http://github.com/Unidata/netcdf-c</a>.
\subsection credits Credits
\subsection this_release Learn more about the current NetCDF-C Release
- \ref release_notes
- \ref getting_and_building_netcdf
\subsection learn-more Learn more about using NetCDF-C
- \ref tutorial
- \ref user_guide
- \ref netcdf_working_with_netcdf_files
- <a class="el" href="http://www.unidata.ucar.edu/software/netcdf/docs/index-413.html">Older Documentation, plus details regarding netcdf-fortran and netcdf-cxx.</a>
\subsection netcdf-cmake-windows NetCDF CMake and Windows support:
- \ref netCDF-CMake
- \ref winbin
\subsection netcdf_credits Credits
\authors Russ Rew, Glenn Davis, Steve Emmerson, Harvey Davies, Ed
Hartnett, Dennis Heimbigner and Ward Fisher
<p>NetCDF was developed and is maintained
at <a href="http://www.unidata.ucar.edu">Unidata</a>, part of the
@ -20,25 +40,10 @@ at <a href="http://www.unidata.ucar.edu">Unidata</a>, part of the
Programs</a> (UCP). Unidata is funded primarily by the National Science
Foundation.
\authors Russ Rew, Glenn Davis, Steve Emmerson, Harvey Davies, Ed
Hartnett, Dennis Heimbigner and Ward Fisher
\subsection this_release Learn more about the current NetCDF-C Release
<a href="http://www.unidata.ucar.edu">Unidata</a> provides data and
software tools for use in geoscience education and research.
- \ref release_notes
- \ref getting
- \ref building
\subsection learn-more Learn more about using NetCDF-C
- \ref tutorial
- \ref user_guide
- <a class="el" href="http://www.unidata.ucar.edu/software/netcdf/docs/index-413.html">Older Documentation, plus details regarding netcdf-fortran and netcdf-cxx.</a>
\section netcdf-cmake-windows NetCDF CMake and Windows support:
- \ref netCDF-CMake
- \ref winbin
\internal
@ -55,7 +60,4 @@ library, or a DAP client accessing remote data.
\endinternal
<a href="http://www.unidata.ucar.edu">Unidata</a> provides data and
software tools for use in geoscience education and research.
*/

28
man4/tutorial.dox
View File

@ -2,6 +2,8 @@
\page tutorial NetCDF Tutorials
\tableofcontents
\section sec_tut Tutorial Documentation
This page contains refrences to various other NetCDF background and tutorial pages.
@ -25,7 +27,7 @@ This page contains refrences to various other NetCDF background and tutorial pag
\subsection sub_sec_tools_for_netcdf Tools for NetCDF:
- \ref netcdf_utilities
- \ref netcdf_tools
- \ref external_netcdf_tools
\subsection sub_sec_programming_with_netcdf Programming with NetCDF:
- \ref netcdf_apis
@ -50,35 +52,47 @@ Unidata is part of the University Corporation for Atmospheric Research
href="http://www.uop.ucar.edu">UCP</a>). Unidata is funded primarily
by the National Science Foundation.
\page netcdf_utilities The NetCDF Utilities
\page netcdf_working_with_netcdf_files Working with NetCDF Files from the command line.
\brief Options for working with netcdf-formatted files from the command line or with an external program.
\tableofcontents
\section netcdf_utilities The NetCDF Utilities
The ncdump command reads a netCDF file and outputs text in a format
called CDL. The ncgen command reads a text file in CDL format, and
generates a netCDF data file. The nccopy command copies a netCDF file
from one binary format to another, optionally changing compression and
chunksize settings.
\section netcdf_utilities_ncdump ncdump
\subsection netcdf_utilities_ncdump ncdump
The utility ncdump can be used to show the contents of netCDF
files. By default, ncdump shows the CDL description of the file. This
CDL description can be fed into ncgen to create the data file.
\section netcdf_utilities_ncgen ncgen
See also: \ref guide_ncdump
\subsection netcdf_utilities_ncgen ncgen
The ncgen utility can take an ASCII input file, in CDL format, and
generate a binary netCDF file. It is the opposite of ncdump.
\section netcdf_utilities_nccopy nccopy
See also:
- \ref guide_ncgen
- \ref guide_ncgen3
\subsection netcdf_utilities_nccopy nccopy
The nccopy utility can copy a netCDF file, changing binary format,
chunk sizes, compression, and other storage settings.
\page netcdf_tools Tools for Manipulating NetCDF Files
See also: \ref guide_nccopy
Many existing software applications can read and manipulate netCDF
\section external_netcdf_tools Tools for Manipulating NetCDF Files
Many existing 3rd-party software applications can read and manipulate netCDF
files. Before writing your own program, check to see if any existing
programs meet your needs.