From c1ba49d2a4159ca30205bddc7012ca67ca069722 Mon Sep 17 00:00:00 2001 From: Ward Fisher Date: Fri, 8 Feb 2013 23:14:03 +0000 Subject: [PATCH] Updated documentation for 4.3 --- man4/Building-with-CMake.md | 2 ++ man4/Doxyfile.in | 3 ++- man4/Doxyfile.in.cmake | 1 + man4/install.doc | 6 ++++- man4/windows-binaries.md | 49 +++++++++++++++++++++++++++++++++++++ 5 files changed, 59 insertions(+), 2 deletions(-) create mode 100644 man4/windows-binaries.md diff --git a/man4/Building-with-CMake.md b/man4/Building-with-CMake.md index d76f14d9d..8363e4c25 100644 --- a/man4/Building-with-CMake.md +++ b/man4/Building-with-CMake.md @@ -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. 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 The output of the configuration step is a project file based on the appropriate configurator specified. Common configurators include: diff --git a/man4/Doxyfile.in b/man4/Doxyfile.in index 967a04061..a232018f7 100644 --- a/man4/Doxyfile.in +++ b/man4/Doxyfile.in @@ -573,7 +573,8 @@ INPUT = \ @abs_top_srcdir@/man4/tutorial.doc \ @abs_top_srcdir@/man4/install.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/types.doc \ @abs_top_srcdir@/man4/notes.doc \ diff --git a/man4/Doxyfile.in.cmake b/man4/Doxyfile.in.cmake index 3278eb737..e171d4eae 100644 --- a/man4/Doxyfile.in.cmake +++ b/man4/Doxyfile.in.cmake @@ -656,6 +656,7 @@ WARN_LOGFILE = # with spaces. 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/tutorial.doc \ @CMAKE_SOURCE_DIR@/man4/install.doc \ diff --git a/man4/install.doc b/man4/install.doc index 052063308..0743ca525 100644 --- a/man4/install.doc +++ b/man4/install.doc @@ -47,9 +47,13 @@ full functionality. (See \ref architecture). - \ref build_classic - \ref build_hdf4 - \ref build_parallel -- \ref netCDF-CMake - \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 The usual way of building netCDF requires the HDF5, zlib, and curl diff --git a/man4/windows-binaries.md b/man4/windows-binaries.md new file mode 100644 index 000000000..edfcbb582 --- /dev/null +++ b/man4/windows-binaries.md @@ -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 + +
+ +
+ +# 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 , 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 \ No newline at end of file