Updated documentation for 4.3

This commit is contained in:
Ward Fisher 2013-02-08 23:14:03 +00:00
parent 2ebe0985f3
commit c1ba49d2a4
5 changed files with 59 additions and 2 deletions

View File

@ -29,6 +29,8 @@ There are four steps in the Build Process when using CMake
3. Testing: Post-build, it is possible to run tests to ensure the functionality of the netCDF-C libraries. 3. Testing: Post-build, it is possible to run tests to ensure the functionality of the netCDF-C libraries.
4. Installation: If all tests pass, the libraries can be installed in the location specified during configuration. 4. Installation: If all tests pass, the libraries can be installed in the location specified during configuration.
For users who prefer pre-built binaries, installation packages are available at \ref winbin
## Configuration ## Configuration
The output of the configuration step is a project file based on the appropriate configurator specified. Common configurators include: The output of the configuration step is a project file based on the appropriate configurator specified. Common configurators include:

View File

@ -573,7 +573,8 @@ INPUT = \
@abs_top_srcdir@/man4/tutorial.doc \ @abs_top_srcdir@/man4/tutorial.doc \
@abs_top_srcdir@/man4/install.doc \ @abs_top_srcdir@/man4/install.doc \
@abs_top_srcdir@/man4/dispatch.doc \ @abs_top_srcdir@/man4/dispatch.doc \
@abs_top_srcdir@/man4/win_netcdf.doc \ @abs_top_srcdir@/man4/Building-with-CMake.md \
@abs_top_srcdir@/man4/windows-binaries.md \
@abs_top_srcdir@/man4/guide.doc \ @abs_top_srcdir@/man4/guide.doc \
@abs_top_srcdir@/man4/types.doc \ @abs_top_srcdir@/man4/types.doc \
@abs_top_srcdir@/man4/notes.doc \ @abs_top_srcdir@/man4/notes.doc \

View File

@ -656,6 +656,7 @@ WARN_LOGFILE =
# with spaces. # with spaces.
INPUT = @CMAKE_SOURCE_DIR@/man4/Building-with-CMake.md \ INPUT = @CMAKE_SOURCE_DIR@/man4/Building-with-CMake.md \
@CMAKE_SOURCE_DIR@/man4/windows-binaries.md \
@CMAKE_SOURCE_DIR@/man4/mainpage.doc \ @CMAKE_SOURCE_DIR@/man4/mainpage.doc \
@CMAKE_SOURCE_DIR@/man4/tutorial.doc \ @CMAKE_SOURCE_DIR@/man4/tutorial.doc \
@CMAKE_SOURCE_DIR@/man4/install.doc \ @CMAKE_SOURCE_DIR@/man4/install.doc \

View File

@ -47,9 +47,13 @@ full functionality. (See \ref architecture).
- \ref build_classic - \ref build_classic
- \ref build_hdf4 - \ref build_hdf4
- \ref build_parallel - \ref build_parallel
- \ref netCDF-CMake
- \ref configure_options - \ref configure_options
\section sub CMake and Windows support
- \ref netCDF-CMake
- \ref winbin
\page build_default Building with NetCDF-4 and the Remote Data Client \page build_default Building with NetCDF-4 and the Remote Data Client
The usual way of building netCDF requires the HDF5, zlib, and curl The usual way of building netCDF requires the HDF5, zlib, and curl

49
man4/windows-binaries.md Normal file
View File

@ -0,0 +1,49 @@
\page winbin Installing and Using netCDF-C Libraries in a Windows Environment
There are several development environments available for programmers who develop on Windows.
* Microsoft Visual Studio
* MSYS/MinGW
* Cygwin
For the latter two, the Linux/Unix build instructions may be used. For the former build environment, you may download using the Windows build instructions, or you may download the pre-built netCDF-C libraries from this page.
# Getting pre-built netCDF-C Libraries for Visual Studio
These libraries can be used with Visual Studio 2010 projects. The downloads are installer packages which contain the netCDF-C libraries and utilities (ncgen, ncgen3, ncdump and nccopy), as well as the associated dependencies.
Configuration | 32-bit | 64-bit |
:-------------------|:-------- |:-------|
netCDF 3 | [netCDF4.3RC1-NC3-32.exe][1] | [netCDF4.3RC1-NC3-64.exe][5]
netCDF3+DAP | [netCDF4.3RC1-NC3-DAP-32.exe][2] | [netCDF4.3RC1-NC3-DAP-64.exe][6]
netCDF4 | [netCDF4.3RC1-NC4-32.exe][3] | [netCDF4.3RC1-NC4-64.exe][7]
netCDF4+DAP | [netCDF4.3RC1-NC4-DAP-32.exe][4] | [netCDF4.3RC1-NC4-DAP-64.exe][8]
# Using the netCDF-C Libraries with Visual Studio
In order to use the netcdf libraries, you must ensure that the .dll files (along with any dependencies from deps/shared/bin) are on the system path. In order to compile a program using these libraries, you must first link your program against the appropriate 'import' (.lib) libraries.
## Install Hierarchy
When installed, the netCDF libraries are placed in the specified locations, along with the netCDF-C utilities and
<center>
<IMG SRC=http://www.unidata.ucar.edu/software/netcdf/win_netcdf/InstallTreeWindows.jpg />
</center>
# Notes
*The following points should be considered when using the netCDF-C libraries on Windows.*
1. Currently, 64-bit offset large file support is only available when using the 64-bit libraries. [NCF-219]
2. When building the netCDF-C libraries with netCDF4 support, using the 'debug' libraries may cause extraneous warnings. These warnings are related to cross-dll memory management, and appear to be harmless. You can safely ignore them by using the 'release' libraries. [NCF-220]
Both of these issues are being actively worked on. The may be tracked in the Unidata JIRA system at <http://bugtracking.unidata.ucar.edu/>, using the provided JIRA identifiers.
[1]: http://www.unidata.ucar.edu/netcdf/win_netcdf/netCDF4.3RC1-NC3-32.exe
[2]: http://www.unidata.ucar.edu/netcdf/win_netcdf/netCDF4.3RC1-NC3-DAP.exe
[3]: http://www.unidata.ucar.edu/netcdf/win_netcdf/netCDF4.3RC1-NC4-32.exe
[4]: http://www.unidata.ucar.edu/netcdf/win_netcdf/netCDF4.3RC1-NC4-DAP-32.exe
[5]: http://www.unidata.ucar.edu/netcdf/win_netcdf/netCDF4.3RC1-NC3-64.exe
[6]: http://www.unidata.ucar.edu/netcdf/win_netcdf/netCDF4.3RC1-NC3-DAP-64.exe
[7]: http://www.unidata.ucar.edu/netcdf/win_netcdf/netCDF4.3RC1-NC4-64.exe
[8]: http://www.unidata.ucar.edu/netcdf/win_netcdf/netCDF4.3RC1-NC4-DAP-64.exe