mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-03 08:01:25 +08:00
bf2746b8ea
re: issue https://github.com/Unidata/netcdf-c/issues/1251 Assume that you have the URL to a remote dataset which is a normal netcdf-3 or netcdf-4 file. This PR allows the netcdf-c to read that dataset's contents as a netcdf file using HTTP byte ranges if the remote server supports byte-range access. Originally, this PR was set up to access Amazon S3 objects, but it can also access other remote datasets such as those provided by a Thredds server via the HTTPServer access protocol. It may also work for other kinds of servers. Note that this is not intended as a true production capability because, as is known, this kind of access to can be quite slow. In addition, the byte-range IO drivers do not currently do any sort of optimization or caching. An additional goal here is to gain some experience with the Amazon S3 REST protocol. This architecture and its use documented in the file docs/byterange.dox. There are currently two test cases: 1. nc_test/tst_s3raw.c - this does a simple open, check format, close cycle for a remote netcdf-3 file and a remote netcdf-4 file. 2. nc_test/test_s3raw.sh - this uses ncdump to investigate some remote datasets. This PR also incorporates significantly changed model inference code (see the superceded PR https://github.com/Unidata/netcdf-c/pull/1259). 1. It centralizes the code that infers the dispatcher. 2. It adds support for byte-range URLs Other changes: 1. NC_HDF5_finalize was not being properly called by nc_finalize(). 2. Fix minor bug in ncgen3.l 3. fix memory leak in nc4info.c 4. add code to walk the .daprc triples and to replace protocol= fragment tag with a more general mode= tag. Final Note: Th inference code is still way too complicated. We need to move to the validfile() model used by netcdf Java, where each dispatcher is asked if it can process the file. This decentralizes the inference code. This will be done after all the major new dispatchers (PIO, Zarr, etc) have been implemented.
98 lines
3.8 KiB
CMake
98 lines
3.8 KiB
CMake
# Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
|
|
# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014,
|
|
# 2015, 2016, 2017, 2018
|
|
# University Corporation for Atmospheric Research/Unidata.
|
|
|
|
# See netcdf-c/COPYRIGHT file for more info.
|
|
|
|
#####
|
|
# Build doxygen documentation, if need be.
|
|
#####
|
|
IF(ENABLE_DOXYGEN)
|
|
# The following is redundant but does not hurt anything.
|
|
|
|
FILE(GLOB COPY_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.html ${CMAKE_CURRENT_SOURCE_DIR}/images ${CMAKE_CURRENT_SOURCE_DIR}/*.doc ${CMAKE_CURRENT_SOURCE_DIR}/*.xml ${CMAKE_CURRENT_SOURCE_DIR}/*.m4 ${CMAKE_CURRENT_SOURCE_DIR}/*.texi ${CMAKE_SOURCE_DIR}/oc2/auth.html.in)
|
|
FILE(COPY ${COPY_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/)
|
|
|
|
# Set abs_top_srcdir to work with the autotools
|
|
# doxyfile template.
|
|
SET(abs_top_srcdir ${CMAKE_SOURCE_DIR})
|
|
SET(abs_builddir ${CMAKE_CURRENT_BINARY_DIR})
|
|
|
|
# Create general and guide doxyfiles.
|
|
CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
|
|
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
|
|
|
|
# Generate User Documentation
|
|
ADD_CUSTOM_TARGET(doc_all ALL
|
|
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
|
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/auth.html ${CMAKE_CURRENT_BINARY_DIR}/html
|
|
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/obsolete/fan_utils.html ${CMAKE_CURRENT_BINARY_DIR}/html
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
COMMENT "Generating API Documentation" VERBATIM)
|
|
|
|
# Create auth.html with some sed commands.
|
|
ADD_CUSTOM_TARGET(oc2-auth
|
|
|
|
cat ${CMAKE_SOURCE_DIR}/oc2/auth.html.in | sed -e "/<OC>/d" | sed -e "s|^<NC>||" | sed -e "s|zz|netcdf|g" -e "s|ZZ|netCDF|g" | sed -e "/stylesheet/r${CMAKE_SOURCE_DIR}/oc2/oc.css" -e "/stylesheet/d" > ${CMAKE_CURRENT_SOURCE_DIR}/auth.html
|
|
COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/auth.html ${CMAKE_CURRENT_BINARY_DIR}/html
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
VERBATIM
|
|
)
|
|
|
|
# If ENABLE_DOXYGEN_LATEX_OUTPUT is true, automatically build
|
|
# the PDF files.
|
|
IF(ENABLE_DOXYGEN_PDF_OUTPUT)
|
|
# Process 'main' netcdf documentation.
|
|
FIND_PROGRAM(NC_MAKE NAMES make)
|
|
FIND_PROGRAM(NC_PDFLATEX NAMES pdflatex)
|
|
IF(NOT NC_MAKE OR NOT NC_PDFLATEX)
|
|
MESSAGE(WARNING "Unable to locate 'make' and/or 'pdflatex' program. Unable to build pdf documentation.")
|
|
ELSE()
|
|
ADD_CUSTOM_TARGET(doc_all_pdf ALL
|
|
make
|
|
COMMAND mv refman.pdf ../netcdf.pdf
|
|
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/latex_main"
|
|
COMMENT "Building NetCDF PDF Documentation" VERBATIM
|
|
)
|
|
|
|
INSTALL(FILES "${CMAKE_CURRENT_BINARY_DIR}/netcdf.pdf"
|
|
"${CMAKE_CURRENT_BINARY_DIR}/netcdf-guide.pdf"
|
|
"${CMAKE_CURRENT_BINARY_DIR}/netcdf-tutorial.pdf"
|
|
DESTINATION "${CMAKE_INSTALL_DOCDIR}/pdf"
|
|
|
|
COMPONENT documentation)
|
|
|
|
ENDIF()
|
|
|
|
ENDIF()
|
|
|
|
|
|
# Copy the image files used by markdown documentation
|
|
# manually.
|
|
FILE(GLOB IMG_FILES ${CMAKE_CURRENT_BINARY_DIR}/images/*.jpg
|
|
${CMAKE_CURRENT_BINARY_DIR}/images/*.png)
|
|
|
|
FILE(COPY ${IMG_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/html)
|
|
|
|
INSTALL(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html/"
|
|
DESTINATION "${CMAKE_INSTALL_DOCDIR}/html"
|
|
COMPONENT documentation)
|
|
|
|
ENDIF(ENABLE_DOXYGEN)
|
|
|
|
# Should match list in Makefile.am
|
|
SET(CUR_EXTRA_DIST ${CUR_EXTRA_DIST}
|
|
netcdf.m4 DoxygenLayout.xml Doxyfile.in footer.html
|
|
mainpage.dox tutorial.dox guide.dox types.dox cdl.dox
|
|
architecture.dox internal.dox windows-binaries.md
|
|
building-with-cmake.md CMakeLists.txt groups.dox install.md notes.md
|
|
install-fortran.md all-error-codes.md credits.md auth.md
|
|
obsolete/fan_utils.html bestpractices.md filters.md indexing.md
|
|
inmemory.md DAP2.dox attribute_conventions.md FAQ.md
|
|
file_format_specifications.md known_problems.md
|
|
COPYRIGHT.dox user_defined_formats.md DAP4.md DAP4.dox
|
|
testserver.dox byterange.dox)
|
|
|
|
ADD_EXTRA_DIST("${CUR_EXTRA_DIST}")
|