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
ef82b79857
netcdf-c/docs/building-with-cmake.md

107 lines
4.2 KiB
Markdown
Raw Normal View History

More document consolidation.
2014-03-01 08:12:34 +08:00
Build Instructions for NetCDF-C using CMake {#netCDF-CMake}
===========================================
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process.
2014-02-25 07:06:09 +08:00
[TOC]
Added TOC, FAQ to CMake instructions document.
2013-08-30 07:04:26 +08:00
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process.
2014-02-25 07:06:09 +08:00
# Overview {#cmake_overview}
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
Added information to RELEASE_NOTES to reflect the 'release candidate' status of the current release. Added information about needing to generate configure scripts with 'autoreconf'. Updated Building with CMake documentation, moved 4.3.0 errata to a place of less prominence.
2013-08-10 01:14:07 +08:00
Starting with netCDF-C 4.3.0, we are happy to announce the inclusion of CMake support. CMake will allow for building netCDF on a wider range of platforms, include Microsoft Windows with Visual Studio. CMake support also provides robust unit and regression testing tools. We will also maintain the standard autotools-based build system in parallel.
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
In addition to providing new build options for netCDF-C, we will also provide pre-built binary downloads for the shared versions of netCDF for use with Visual Studio.
o Fixed the SOVERSION for CMake-based builds. o Updated autotools-based build to include files required for CMake-based builds. o Updated Markdown-based documentation processed by Doxygen to include a CMake FAQ.
2013-05-09 05:59:11 +08:00
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process.
2014-02-25 07:06:09 +08:00
# Requirements {#cmake_requirements}
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
The following packages are required to build netCDF-C using CMake.
* netCDF-C Source Code
Updated documentation to reflect minimum cmake version of 2.8.12.
2014-07-30 04:53:12 +08:00
* CMake version 2.8.12 or greater.
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
* Optional Requirements:
* HDF5 Libraries for netCDF4/HDF5 support.
* libcurl for DAP support.
<center>
Corrected a handful of syntax issues in CMake config files, probably introduced more. Added CMake-related files to Makefile.am files for inclusion when creating a distribution package.
2013-02-21 07:28:28 +08:00
<img src="deptree.jpg" height="250px" />
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
</center>
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process.
2014-02-25 07:06:09 +08:00
# The CMake Build Process {#cmake_build}
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
There are four steps in the Build Process when using CMake
1. Configuration: Before compiling, the software is configured based on the desired options.
2. Building: Once configuration is complete, the libraries are compiled.
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
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process.
2014-02-25 07:06:09 +08:00
## Configuration {#cmake_configuration}
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
The output of the configuration step is a project file based on the appropriate configurator specified. Common configurators include:
* Unix Makefiles
* Visual Studio
* CodeBlocks
* ... and others
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process.
2014-02-25 07:06:09 +08:00
### Common CMake Options {#cmake_common_options}
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
| **Option** | **Autotools** | **CMake** |
Updated CMake-related documentation in generated websites with more detail.
2013-06-05 01:33:21 +08:00
| :------- | :---- | :----- |
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
Specify Install Location | --prefix=PREFIX | -D"CMAKE\_INSTALL\_PREFIX=PREFIX"
Enable/Disable netCDF-4 | --enable-netcdf-4<br>--disable-netcdf-4 | -D"ENABLE\_NETCDF\_4=ON" <br> -D"ENABLE\_NETCDF\_4=OFF"
Enable/Disable DAP | --enable-dap <br> --disable-dap | -D"ENABLE\_DAP=ON" <br> -D"ENABLE\_DAP=OFF"
Enable/Disable Utilities | --enable-utilities <br> --disable-utilities | -D"BUILD\_UTILITIES=ON" <br> -D"BUILD\_UTILITIES=OFF"
Specify shared/Static Libraries | --enable-shared <br> --enable-static | -D"BUILD\_SHARED\_LIBS=ON" <br> -D"BUILD\_SHARED\_LIBS=OFF"
Enable/Disable Tests | --enable-testsets <br> --disable-testsets | -D"ENABLE\_TESTS=ON" <br> -D"ENABLE\_TESTS=OFF"
Updated CMake-related documentation in generated websites with more detail.
2013-06-05 01:33:21 +08:00
Specify a custom library location | Use *CFLAGS* and *LDFLAGS* | -D"CMAKE\_PREFIX\_PATH=/usr/custom_libs/"
A full list of *basic* options can be found by invoking `cmake [Source Directory] -L`. To enable a list of *basic* and *advanced* options, one would invoke `cmake [Source Directory] -LA`.
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process.
2014-02-25 07:06:09 +08:00
### Configuring your build from the command line. {#cmake_command_line}
Updated CMake-related documentation in generated websites with more detail.
2013-06-05 01:33:21 +08:00
The easiest configuration case would be one in which all of the dependent libraries are installed on the system path (in either Unix/Linux or Windows) and all the default options are desired. From the build directory (often, but not required to be located within the source directory):
Fixed some markdown syntax errors on the 'building with cmake' document.
2014-02-06 04:19:00 +08:00
> $ cmake [Source Directory]
Updated CMake-related documentation in generated websites with more detail.
2013-06-05 01:33:21 +08:00
If you have libraries installed in a custom directory, you may need to specify the **CMAKE\_PREFIX_PATH** variable to tell cmake where the libraries are installed. For example:
Fixed some markdown syntax errors on the 'building with cmake' document.
2014-02-06 04:19:00 +08:00
> $ cmake [Source Directory] -DCMAKE\_PREFIX\_PATH=/usr/custom_libraries/
Updated CMake-related documentation in generated websites with more detail.
2013-06-05 01:33:21 +08:00
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process.
2014-02-25 07:06:09 +08:00
## Building {#cmake_building}
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
The compiler can be executed directly with 'make' or the appropriate command for the configurator which was used.
Fixed some markdown syntax errors on the 'building with cmake' document.
2014-02-06 04:19:00 +08:00
> $ make
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
Building can also be executed indirectly via cmake:
Fixed some markdown syntax errors on the 'building with cmake' document.
2014-02-06 04:19:00 +08:00
> $ cmake --build [Build Directory]
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process.
2014-02-25 07:06:09 +08:00
## Testing {#cmake_testing}
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
Testing can be executed several different ways:
Fixed some markdown syntax errors on the 'building with cmake' document.
2014-02-06 04:19:00 +08:00
> $ make test
o Fixed the SOVERSION for CMake-based builds. o Updated autotools-based build to include files required for CMake-based builds. o Updated Markdown-based documentation processed by Doxygen to include a CMake FAQ.
2013-05-09 05:59:11 +08:00
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
or
o Fixed the SOVERSION for CMake-based builds. o Updated autotools-based build to include files required for CMake-based builds. o Updated Markdown-based documentation processed by Doxygen to include a CMake FAQ.
2013-05-09 05:59:11 +08:00
Fixed some markdown syntax errors on the 'building with cmake' document.
2014-02-06 04:19:00 +08:00
> $ ctest
o Fixed the SOVERSION for CMake-based builds. o Updated autotools-based build to include files required for CMake-based builds. o Updated Markdown-based documentation processed by Doxygen to include a CMake FAQ.
2013-05-09 05:59:11 +08:00
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
or
o Fixed the SOVERSION for CMake-based builds. o Updated autotools-based build to include files required for CMake-based builds. o Updated Markdown-based documentation processed by Doxygen to include a CMake FAQ.
2013-05-09 05:59:11 +08:00
Fixed some markdown syntax errors on the 'building with cmake' document.
2014-02-06 04:19:00 +08:00
> $ cmake --build [Build Directory] --target test
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process.
2014-02-25 07:06:09 +08:00
## Installation {#cmake_installation}
Corrected parallel support in CMake, including library checks and parallel IO tests. Updated CMake-related documentation.
2013-02-13 06:22:54 +08:00
Once netCDF has been built and tested, it may be installed using the following commands:
Fixed some markdown syntax errors on the 'building with cmake' document.
2014-02-06 04:19:00 +08:00
> $ make install
o Fixed the SOVERSION for CMake-based builds. o Updated autotools-based build to include files required for CMake-based builds. o Updated Markdown-based documentation processed by Doxygen to include a CMake FAQ.
2013-05-09 05:59:11 +08:00
Fixed some markdown syntax errors on the 'building with cmake' document.
2014-02-06 04:19:00 +08:00
or
o Fixed the SOVERSION for CMake-based builds. o Updated autotools-based build to include files required for CMake-based builds. o Updated Markdown-based documentation processed by Doxygen to include a CMake FAQ.
2013-05-09 05:59:11 +08:00
Fixed some markdown syntax errors on the 'building with cmake' document.
2014-02-06 04:19:00 +08:00
> $ cmake --build [Build Directory] --target install
o Fixed the SOVERSION for CMake-based builds. o Updated autotools-based build to include files required for CMake-based builds. o Updated Markdown-based documentation processed by Doxygen to include a CMake FAQ.
2013-05-09 05:59:11 +08:00
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process.
2014-02-25 07:06:09 +08:00
# See Also {#cmake_see_also}
Added information to RELEASE_NOTES to reflect the 'release candidate' status of the current release. Added information about needing to generate configure scripts with 'autoreconf'. Updated Building with CMake documentation, moved 4.3.0 errata to a place of less prominence.
2013-08-10 01:14:07 +08:00
More document consolidation.
2014-03-01 08:12:34 +08:00
For further information regarding NetCDF and CMake, see \ref cmake_faq
Reference in New Issue Copy Permalink