Commit Graph

316 Commits

Author SHA1 Message Date
Dennis Heimbigner
e226cc731e Add note about .daprc vs .dodsrc 2017-08-28 15:50:33 -06:00
Ward Fisher
71db48eb78 Updated types documentation in support of https://github.com/Unidata/netcdf-c/issues/469 2017-08-28 12:55:30 -06:00
Dennis Heimbigner
ed44fd7306 Add szip support via libaec 2017-08-27 13:35:20 -06:00
pelson
b5866843dc Added detail about _FillValue being undefined. 2017-08-22 14:33:58 +01:00
Dennis Heimbigner
5085df7595 1. Add discussion of parameter encoding, esp in face of byte-order,
to docs/filter.md
2. Moved location of filter.md in documentation
3. Add a template file as the basis for building new filters.
4. Did some test case cleanup
2017-08-21 19:54:06 -06:00
Ward Fisher
ceb3b4bc1c Merge branch 'master' of https://github.com/edhartnett/netcdf-c into v4.5.0-release-branch 2017-08-21 15:16:25 -06:00
Dennis Heimbigner
37834917e9 Fix up documentation to replace old auth documentation
with a revised auth.md document.
2017-08-20 18:27:48 -06:00
edhartnett
6ef8dc32fe fixed some refs 2017-08-20 04:40:27 -06:00
Dennis Heimbigner
7e8bd784cc Merge branch 'master' into filters.dmh 2017-08-17 14:29:34 -06:00
edhartnett
40e53580b6 fixed some refs 2017-08-15 14:01:17 -06:00
edhartnett
6b407dd38b fixed a subsection header 2017-08-15 13:33:03 -06:00
edhartnett
50566bad6b fixed some refs 2017-08-15 13:30:55 -06:00
Dennis Heimbigner
86fc8745dc merge master and resolve conflicts 2017-08-12 15:50:31 -06:00
Ward Fisher
8fcf0e53cc Merge branch 'master' of https://github.com/edhartnett/netcdf-c into two-pulls 2017-08-10 14:30:05 -06:00
edhartnett
96c8e190e7 fixed table and link in Large File section 2017-08-10 12:44:57 -06:00
Ward Fisher
b50508479a Added a new product to the static software html page. 2017-08-08 16:11:13 -06:00
Dennis Heimbigner
7f31358ee2 As a result of helping a user trying to build the filter test on
a linux variant system, I made some changes to (one hopes)
incorporate some improvements in documenting and building this test.
2017-07-25 15:57:00 -06:00
Greg Sjaardema
1503013e33 Eliminate NC_MAX_VARS|DIMS|ATTRS limits 2017-07-20 09:32:29 -06:00
Ward Fisher
74448c6c2d Merge branch 'master' into DennisHeimbigner-patch-1 2017-07-06 13:44:25 -06:00
Ward Fisher
6da1539ff9 Removed software.md from dist file. 2017-06-07 12:58:23 -06:00
Ward Fisher
ecd40e688b Removed old unused file, static html version was moved into static/ subdirectory 2017-06-06 10:48:15 -06:00
Ward Fisher
ec33411c6c Bumped revision information to next version. 2017-06-01 13:35:39 -06:00
DennisHeimbigner
a0cc0a195b Update install.md 2017-05-30 13:51:33 -06:00
Dennis Heimbigner
d37ac215e2 Add new capabilities to filter code:
1. Allow nccopy to apply filters, especially on the output file.
   This provides a third way to do this other than using ncgen or
   programatically
2. Make sure that even if the filter code is not available, it is
   possible to see the filter id and parameters for variables using
   e.g ncdump -hs.
3. Fix bug in nccopy so that the input file does
   not necessarily have to be netcdf-4.
4. At last minute decided to change to using a
   single "_Filter" attribute for ncgen
5. Added a test to tst_filter.sh to generate C code using ncgen.
2017-05-14 18:10:02 -06:00
Dennis Heimbigner
7c3164577e Finalize the compression support.
This relies on the HDF5 capability to
dynamically load compression filters.
Note that a compression filter is just
a subcase of filters.

The primary user-visible changes are as follows:
1. Add a standard header "netcdf_filter.h" that defines
   the necessary API extensions
2. Modify ncgen to support two new special attributes
   "_Filter_ID" and "_Filter_Parameters" so that compression
   can be turned on when creating a file using ncgen.
4. Add a detailed description of filtering support
   to the user's guide; see the file filters.md
5. Add a test case directory for this: nc_test4/filter_test.
   It is fragile and a ./configure flags (-enable-filter-test)
   is defined (default disabled) to shut this off this test
   to avoid spurious 'make check' failures.

Note that the HDF5 documentation is not up-to-date, so
much of what is encoded here comes from examining the
actual code in the file H5PL.c in the HDF5 source code.
2017-04-27 13:01:59 -06:00
Dennis Heimbigner
6a4ba35565 Fix pull request https://github.com/Unidata/netcdf-c/pull/374 (dap4.dmh)
1. Cleanup test_common.sh to expunge (mostly) the use of the VS
   path value. This has the effect of being unable to use the
   Visual Studio C compiler for shell tests.
2. There is a missing case in CMakeLists.txt so add
   defaulting for HDF5_C_LIBRARY_hdf5 using HDF5_C_LIBRARY.
   Ward should probably examine this to get it fixed correctly.
3. Put back ref to esg.md in docs/Doxyfile.in
4. Fix minor warning in dut8proc.h
2017-04-10 09:26:57 -06:00
Dennis Heimbigner
e1e7c77c26 Add initial DAP4 documentation 2017-04-06 10:06:32 -06:00
Dennis Heimbigner
6d8809100f Fix pull request https://github.com/Unidata/netcdf-c/pull/374 (dap4.dmh)
1. When running under windows (as opposed to cygwin)
   we need to make sure to not user /cygdrive/ file paths.
   This was ocurring in libdap4/d4read.c, but may occur
   elsewhere.
2. Shell scripts in the git repo are not being checked-out
   with the executable mode set. Had core.filemode set to false.
   Was a major hassle to fix.
2017-04-03 21:39:44 -06:00
Stephan Hoyer
4dd8e380c1 Switch NC_CHAR on netCDF4 to use ASCII
Fixes GH298
2017-03-13 20:12:08 -07:00
Ward Fisher
74a07272af Updated software.html page with reference to ArcGIS Pro Space Time Pattern Toolbox 2017-02-27 13:20:48 -07:00
Ward Fisher
f79392ce21 Added release to release header. 2016-11-21 11:23:02 -07:00
Ward Fisher
99c8bccd85 Tweaked options table in install document. 2016-10-27 14:13:29 -06:00
Ward Fisher
08609a6ed4 Cleaning up the install doc, and updating some missing items. 2016-10-27 13:36:26 -06:00
Ward Fisher
a3327a3621 removed outdated information re: parallel netcdf. 2016-10-10 10:53:25 -06:00
Ward Fisher
b6c5d34c32 Updated documentation to reflect DAP2 reserved keywords. See https://github.com/Unidata/netcdf-c/issues/308 for more info. 2016-09-19 15:36:50 -06:00
Ward Fisher
5132ffa80f Corrected dead links. 2016-09-13 11:21:42 -06:00
Bas Couwenberg
988b4ff868 Fix spelling errors.
* characers -> characters
 * varaible  -> variable
2016-08-28 15:45:36 +02:00
Dennis Heimbigner
0cf1e2c49f re: Github issue netcdf-c 300
Modified provenance code to allocate the minimal space
needed for _NCProperties attribute in file.  Basically
required using malloc in the provenance code and in ncdump.
Otherwise should cause no externally visible effects.
Also removed the ENABLE_FILEINFO from configure.ac since
the provenance code is no longer optional.
2016-08-08 09:24:19 -06:00
Ward Fisher
13fabc4036 Merge branch 'doc-update' 2016-07-08 10:26:31 -06:00
Ward Fisher
973ec5f2ad Updated hdf5 version in documentation for pre-built Windows installers. 2016-07-07 15:14:48 -06:00
Ward Fisher
e502b40d6a Updated static software html page. 2016-06-27 15:38:29 -06:00
Ward Fisher
a9b04ec696 Corrected a doxygen issue in types.dox. 2016-06-24 15:31:13 -06:00
Ward Fisher
1beeef771d Removing generated version of software.html. 2016-06-24 15:05:06 -06:00
Ward Fisher
09751a638e Moving static, non-generated software into version control. 2016-06-24 15:02:18 -06:00
Ward Fisher
49b416182a Flagged _netcdf_dim_info and _netcdf_var_info as deprecated in documentation in service of https://github.com/Unidata/netcdf-c/issues/254 2016-06-16 14:07:42 -06:00
Ward Fisher
dc1a9c34d8 Added a document to catalog what the various tests are. 2016-06-06 14:51:57 -06:00
Dennis Heimbigner
4fa1470241 re: github issue https://github.com/Unidata/netcdf-c/issues/265
Charlie Zender noted that we forgot to define what happens for
various netcdf API attribute operations, notably nc_inq_att()
and nc_get_att().
So, I added a list of legal and illegal api calls for the provenance
attributes in docs/attribute_conventions.md.
I also added more test cases to ncdump/tst_fileinfo.c to verify
and fixed resultant errors.
2016-05-15 18:03:04 -06:00
Ward Fisher
3f10f26315 Updated hdf5 information for pre-built Windows binaries. 2016-05-13 12:39:21 -06:00
Ward Fisher
6c0312293b Corrected dead links referencing the fortran 77, fortran 90 and C++ interfaces. 2016-05-12 16:40:50 -06:00
Ward Fisher
f0a3ad70fe Merge branch 'master' into provenance 2016-05-11 15:43:30 -06:00
Ward Fisher
8221d8113a Cleaned up best practices document. 2016-05-09 20:42:35 -06:00
Ward Fisher
14580681cc Added best practices document to generated documentation. 2016-05-09 20:32:42 -06:00
Dennis Heimbigner
11a259ad86 Add provenance info for netcdf-4 files.
This consists of a persistent attribute named
_NCProperties plus two computed attributes
_IsNetcdf4 and _SuperblockVersion.
See the 'Provenance Attributes' section
of docs/attribute_conventions.md for details.
2016-05-07 14:32:07 -06:00
Ward Fisher
31aab90f7c Added information to software.md 2016-04-15 11:06:40 -06:00
Ward Fisher
7f997ffb0b Updated types.dox to reflect that some types are supported in CDF5 files. 2016-03-28 19:22:35 +00:00
ddirks
c8e922dc92 Tweaks to css
Fix placement of version selection dropdown and search box.
2016-01-21 11:19:23 -07:00
Ward Fisher
1805ef0668 Tweaks to style sheet with assistance from @ddirks 2016-01-21 10:11:17 -07:00
Ward Fisher
97883f81d5 Adding an obsolete fan_utils file. 2016-01-19 16:22:57 -07:00
Ward Fisher
94451d18d8 Adding fan_utils.html. 2016-01-19 16:15:51 -07:00
Ward Fisher
b86367c354 Working on netcdf document reorganization, wiring in the first of several stand-alone pages. 2016-01-15 14:59:40 -07:00
Ward Fisher
026f21a2cd Additional dead link modification. 2016-01-15 14:39:32 -07:00
Ward Fisher
75b5eeee20 Fixing links for document reorganization. 2016-01-15 14:25:24 -07:00
Ward Fisher
530ff30ae1 More doxygen tweaks. 2016-01-15 12:23:56 -07:00
Ward Fisher
21069d4684 Converted esg documentation to markdown, make it part of the generated documentation. 2016-01-15 12:17:12 -07:00
Ward Fisher
aed597784a Added esg documentation to generated documentation. 2016-01-15 11:07:18 -07:00
Ward Fisher
60886ec7cd More work removing dead links. 2016-01-14 17:02:26 -07:00
Ward Fisher
8f4fdf1cc5 Cleaning up dead links 2016-01-14 16:53:53 -07:00
Ward Fisher
8263c76746 Doxygen refactoring. 2016-01-14 16:35:34 -07:00
Ward Fisher
374a8f4193 More cleaning up of documentation (there will probably be a lot of this) and tweaking files so that documentation renders as expected. 2016-01-14 16:02:00 -07:00
Ward Fisher
30e1cca0d0 Reorganized file/datastream IO functions in documentation. 2016-01-14 15:50:50 -07:00
Ward Fisher
3f27ec6db4 Tightening the Doxygen documentation. 2016-01-14 15:33:50 -07:00
Ward Fisher
04db4cd4a7 Removed stray style sheet option. 2016-01-14 14:29:43 -07:00
Ward Fisher
75b0bcf07e Trying to sort out why netcdf parallel documentation isn't being generated. 2016-01-14 11:02:23 -07:00
Ward Fisher
10aed48aac Updated release document header. 2016-01-13 12:20:28 -07:00
Ward Fisher
c6b5aa47d1 Bumped version in Developer doxygen file. 2016-01-13 10:05:11 -07:00
Ward Fisher
e17dfb4581 Provided clarification re: netcdf parallel io, see issue https://github.com/Unidata/netcdf-c/issues/157 on GitHub for more information. 2016-01-04 14:29:40 -07:00
Ward Fisher
e6e4851364 Added a link in the documentation to the scinetcdf interface, https://atoms.scilab.org/toolboxes/scinetcdf 2015-11-23 14:39:29 -06:00
Ward Fisher
2683652d4c Added a reference to netcdf4-js interface. 2015-11-16 14:37:44 -07:00
Ward Fisher
0f1e262090 Moved developer doxyfile into docs directory, made windows-binaries document more generalized. 2015-11-10 14:44:43 -07:00
Ward Fisher
5d93b9da9f Tweaked cmake faq. 2015-11-10 11:19:05 -07:00
Ward Fisher
3e60daa49d Corrected a typo reported in https://github.com/Unidata/netcdf-c/issues/146 2015-11-10 10:58:31 -07:00
Ward Fisher
612b35a84c Merge branch 'master' into cdf-5, in preparation for merging the CDF-5 functionality into the master branch. This will be the key new feature for netcdf 4.4.0. 2015-11-05 13:40:35 -07:00
Ward Fisher
1f52d14392 Reintroduced ENABLE_DOXYGEN_SERVER_BASED_SEARCH option for local webserver use. 2015-11-02 12:58:29 -07:00
Ward Fisher
9018649d9b Re-adding server-side search option. 2015-11-02 12:46:09 -07:00
Ward Fisher
0ef498e6b5 Reworked doxygen so that auth.html is only generated when needed, as I'm sure it was originally intended. Created a specific make target in docs directory, 'oc2-auth', for autotools and cmake. 2015-10-27 18:23:54 -06:00
Ward Fisher
680bbb61ce Tweaked makefile.am to accomodate new auth.html 2015-10-27 18:09:22 -06:00
Ward Fisher
49dfc5beef Updated doxygen to work properly with auth.html. 2015-10-27 17:56:28 -06:00
Ward Fisher
64a42f4f8a Fixing generation of doxygen-based documentation. 2015-10-27 15:32:18 -06:00
dmh
7480d7d97d - clean up the dfile.c confusion about NC_64_BIT_OFFSET
- sync oc2 with  master for https://DennisHeimbigner@github.com/Unidata/oc.git
- Cleanup auth.html documentation.
- Cleanup obsolete documentation.
2015-10-24 21:45:13 -06:00
Ward Fisher
a359cb6a53 Reverted some of the spelling corrections. Some misspellings were intentional 2015-10-16 14:36:17 -06:00
Ward Fisher
519a56019f Merge branch 'fix-typos' of https://github.com/tbeu/netcdf-c into tbeu-fix-typos 2015-10-16 14:16:09 -06:00
Ward Fisher
febc9040a5 Updated in-code documentation. 2015-10-15 11:29:51 -06:00
Ward Fisher
d746e3f073 Updated default chunking scheme documentation as per Russ Rew. 2015-10-14 13:16:28 -06:00
dmh
49597a64af merge-squash 2015-10-09 10:12:11 -06:00
Ward Fisher
33f8d2321d Tweaking the new header provided by Jen to allow for multiple documentation links. 2015-09-23 14:55:23 -06:00
Ward Fisher
628f43059f Tweaked Header. 2015-09-23 14:42:24 -06:00
Ward Fisher
aa01e72406 More link fixes. 2015-09-23 14:38:37 -06:00
Ward Fisher
e2cc13df18 Removed some typos and fixed some dead links in documentation. 2015-09-23 14:35:33 -06:00
Ward Fisher
24e94c9d62 Rolled known problems into generated documentation, and cleaning up broken links. 2015-09-23 13:49:06 -06:00
Ward Fisher
04de80ad5d Updated credits file to reflect information for Ward. 2015-09-22 13:15:26 -06:00
tbeu
e2820e4d8a Fix common typos
Detected by https://github.com/vlajos/misspell_fixer
2015-08-20 11:42:05 +02:00
Ward Fisher
b26598c833 Merging Jen's new search option for releases into user documentation. 2015-08-17 10:59:32 -06:00
dmh
28a243b7a3 add note that parallel make cannot be used for make check 2015-07-20 16:53:34 -06:00
Russ Rew
905c35d09c Make README.md less C-centric, add DOI citation question and answer to FAQ. 2015-07-15 09:17:15 -06:00
Ward Fisher
c7484cb4d4 Converted hand-maintained table of contents into a doxygen-generated table of contents. This will allow us to generate PDF user documentation. 2015-07-09 15:29:05 -06:00
Russ Rew
2a059523d3 Make Unidata netCDF links consistent, all using the 'software/' part of link. 2015-07-06 10:13:46 -06:00
Russ Rew
18f85ed3c3 merge origin 2015-07-06 09:53:07 -06:00
Jennifer Oxelson
eeb98c8cf9 corrected type-o 2015-07-01 11:28:44 -06:00
Jennifer Oxelson
3a93f53e83 Modified URLs paths to remove deprecated packages directory; and to link to opendap.org 2015-07-01 10:37:52 -06:00
Jennifer Oxelson
fbf232b055 Updated logo img src 2015-06-30 13:26:54 -06:00
Russ Rew
30030ce0ad tiny update to FAQ.md 2015-06-30 10:41:05 -06:00
Russ Rew
7c0bd14178 Added commercial entry for Surfer 2015-06-15 14:38:51 -06:00
Russ Rew
157a262f08 Fix doxygen list 2015-06-08 10:20:50 -06:00
Russ Rew
406b999e2a Fixed merge conflict 2015-06-08 10:00:03 -06:00
Russ Rew
5cca4eec35 Fix anchor in FAQ and add use of mpifzz for parallel Fortran builds to Fortran install docs 2015-06-08 09:54:33 -06:00
Ward Fisher
ca84ceb725 Updated release notes to reflect change in pre-built binary version. 2015-06-04 15:46:37 -06:00
Ward Fisher
f539c0f32e Added reference docs for netcdf_mem work performed by Dennis. Updated Windows pre-built binary documentation to reflect the move to Visual Studio 2012, from Visual Studio 2010. 2015-06-04 15:37:52 -06:00
Ward Fisher
67c09af90e Refactor auth to oc_auth. 2015-06-04 15:12:30 -06:00
Ward Fisher
78d0929069 Merge branch 'ward-working'. Cleaning up Doxygen warnings. 2015-06-04 15:05:56 -06:00
Ward Fisher
0f7287a470 Corrected typo. 2015-06-04 15:02:06 -06:00
Ward Fisher
bd099f65df Removed the automatically generated TOC in the software file. 2015-06-04 15:00:05 -06:00
Ward Fisher
44c4390732 Updated generation of auth.md 2015-06-04 14:34:06 -06:00
Ward Fisher
37536f87c7 Reverted to ocauth.html. Instead of processing it automatically, we can use 'pandoc' to migrate one to the other. 2015-06-04 14:30:34 -06:00
Russ Rew
a8573500d9 Restore inadvertently overwritten updated FAQ 'How do I build and install netCDF ...' 2015-06-04 10:04:26 -06:00
Ward Fisher
497b615ed2 Corrected typo in FAQ.md 2015-06-03 15:50:43 -06:00
Ward Fisher
26a157f703 Converted ocauth.html to markdown with Pandoc. 2015-06-03 15:48:14 -06:00
Ward Fisher
76e85a9c76 Working on cleaning up the auth.md file. 2015-06-03 15:15:00 -06:00
Russ Rew
b110e1d7a5 add to FAQ our newly minted DOI to use in citing netCDF 2015-06-03 14:32:35 -06:00
Russ Rew
0e4d70319d Distinguish between shell variables and environment variables in installation documentation. Fix FAQ reference to installation documentation. 2015-05-31 18:51:06 -06:00
Ward Fisher
1745febde0 Merge branch 'ward-working' 2015-05-26 15:39:25 -06:00
Ward Fisher
6cba2a720c Converted html anchors into markdown-style anchors, for processing by Doxygen. 2015-05-26 11:00:35 -06:00
dmh
be5e3cd606 1. Allow for the user specified rc file via the env variable
DAPRCFILE.  Note that the value of this environment
   variable should be the absolute path of the rc file, not
   the path to its containing directory.
2. fixup testauth.sh and add some new tests
3. synch oc
2015-05-24 17:31:39 -06:00
Ward Fisher
d62f382894 Cleaning up software.md file, eliminating warnings and errors generated by doxygen. Not done yet. 2015-05-22 16:03:00 -06:00
Ward Fisher
b5856bc204 Wired the new software.md file into the doxygen toolchain. 2015-05-22 15:41:38 -06:00
Ward Fisher
8610f8da90 Added 'software.md', a markdown-formatted version of the software.html page. This way it can be more easily incorporated into the documentation generated/managed by Doxygen. Conversion was handled by pandoc. 2015-05-22 15:33:44 -06:00
Ward Fisher
0f64cec6bd Changed identifier for FAQ.md for doxygen-based documentation. 2015-05-20 10:26:13 -06:00
Russ Rew
69b2124240 More documenation tweets to improve installation instructions for netCDF-C ands netCDF-Fortran. 2015-05-01 14:39:06 -06:00
Russ Rew
5e94cd9401 Update and simplify instructions for building netcdf-fortran. 2015-04-28 13:28:56 -06:00
Russ Rew
35e5543f03 Add tweaks to install doc. 2015-04-28 11:19:31 -06:00
Russ Rew
bb08d84601 Add tweaks to install doc. 2015-04-28 11:17:47 -06:00
Ward Fisher
078013c0d1 Corrected an undefined reference warning in install.md 2015-04-23 15:42:41 -06:00
Ward Fisher
b44b687f4b Modified auth.md to remove a bunch of warnings. 2015-04-23 15:40:19 -06:00
Russ Rew
522cf5c6ec merge with upstream 2015-04-21 07:03:09 -06:00
Russ Rew
dbd4f6ceb4 Fix more install documentation problems. 2015-04-21 07:00:37 -06:00
dmh
8673e66640 A couple of docs/ .dox files have apparently
been converted to .md.
2015-04-16 16:44:51 -06:00
Ward Fisher
85a69a3fa3 More document reorganization. 2015-03-15 15:29:58 -06:00
Ward Fisher
aee5888f76 Updated doxygen pdf target. 2015-03-13 15:02:13 -06:00
Ward Fisher
ee006f4938 Updated convention documentation, added param and returns tags to comment header for nc_inq_unlimdims 2015-03-13 14:02:20 -06:00
Ward Fisher
d7d5ad1a66 Split off file format specifications into its own file (markdown extension but doxygen-style tags within, for now) and placed it as an appendix at the top level of the NetCDF User's Guide. 2015-03-13 13:28:42 -06:00
Ward Fisher
0530d65de5 Moved attribute conventions to the top level of the NetCDF User's Guide section and positioned it as an appendix, as found in the old and print documentation 2015-03-13 13:17:18 -06:00