Commit Graph

37 Commits

Author SHA1 Message Date
Edward Hartnett
c3d201a8b9
Merge branch 'main' into ejh_doc_4 2022-05-05 08:16:40 -06:00
Edward Hartnett
6849f44896 more doxygen warning fixes 2022-05-03 12:54:14 -06:00
Dennis Heimbigner
f1eaefd91e Update selected documentation
Update the following documentation files:

## docs/FAQ.md
* Discuss the use of UTF-8 names under Windows 10+.

## docs/filters.md
* Add documentation about NCzarr filters.
  * Specifically Codec support and HDF5 <-> Codec translation
* Add documentation about standard filters

## docs/dispatch.md
* Convert from .dox format to .md (markdown) format.
* Add discussion about the user defined dispatch tables.
* Update the example.
* Abbreviate the NC_infermodel documentation and move the more detailed discusion to the companion *dinternal.md* documenation.

## docs/internal.md

This is a (mostly) new file that attempts to provide detailed
descriptions about how various features are implemented inside
the netcdf-c library. The topics currently covered the
following.

### Including C++ Code in the netcdf-c Library {#intern_c++}

The state of C compiler technology has reached the point where
it is possible to include C++ code into the netcdf-c library
code base. The document describes how to do this.

### Managing instances of complex data types

The document describes how to properly handle instances of
complex types (those with variable length).  This involves
having functions that can recursively walk instances of such
types to perform various actions on them.  These new functions
are intended to replace the *nc_free_vlen*, *nc_free_vlens* and
*nc_free_string* functions in *netcdf.h*.

### Inferring File Types

As described in the companion document -- docs/dispatch.md --
when *nc\_create()* or *nc\_open()* is called, the library must
figure out what kind of file is being created or opened.  Once it
has figured out the file kind, the appropriate "dispatch table"
can be used to process that file.

As a result of the introduction of remote data access to the netcdf-c
library, the path arguments to *nc\_open()* and *nc\_create()* have
been extended to support URLs as paths. Processing URLs requires
some significant changes to the file inference algorithm. The
details of that processing are recorded in the document.
2022-03-16 12:38:00 -06:00
Jennifer Oxelson
45bce8d395 docs link updates 2021-11-15 11:19:34 -07:00
Jennifer Oxelson
f7e3d3e44f docs cleanup 2021-11-11 11:40:45 -07:00
Jennifer Oxelson
a11349482c Docs migration 2021-11-11 10:47:49 -07:00
Sean Arms
aefadcc6a5 Update links
Update links to netCDF-java and TDS documentation, as well as
various netCDF related issue trackers.
2021-02-26 15:14:37 -07:00
LProx2020
316dfea205
Update FAQ.md
This edit updates the broken links discussed in Issue #1696
2020-05-29 11:58:38 -04:00
kprussing
af3f2e9362 Update FAQ based on actual usage of HDF5 variables
The CMakeLists.txt actually uses `HDF5_C_LIBRARY` and `HDF5_HL_LIBRARY`
to find non-standard HDF5 installation.  This just updates the FAQ with
the correct usage.
2019-11-19 22:18:46 -05:00
Greg Sjaardema
56c0d5cf8a Spelling fixes 2019-09-18 08:03:01 -06:00
Wei-keng Liao
577fcea506 add missing note about CDF-5 format 2018-07-05 22:54:41 -05:00
Ed Hartnett
0ce3d98dc4 fixed typos in CMake build documentation 2017-11-08 05:26:15 -07:00
Dennis Heimbigner
c3bba5b709 Fix broken link to NCO within FAQ 2017-11-04 14:09:50 -06:00
Ward Fisher
5132ffa80f Corrected dead links. 2016-09-13 11:21:42 -06:00
Ward Fisher
026f21a2cd Additional dead link modification. 2016-01-15 14:39:32 -07:00
Ward Fisher
60886ec7cd More work removing dead links. 2016-01-14 17:02:26 -07:00
Ward Fisher
8263c76746 Doxygen refactoring. 2016-01-14 16:35:34 -07: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
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
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
30030ce0ad tiny update to FAQ.md 2015-06-30 10:41:05 -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
Russ Rew
a8573500d9 Restore inadvertently overwritten updated FAQ 'How do I build and install netCDF ...' 2015-06-04 10:04:26 -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
0f64cec6bd Changed identifier for FAQ.md for doxygen-based documentation. 2015-05-20 10:26:13 -06:00
Russ Rew
dbd4f6ceb4 Fix more install documentation problems. 2015-04-21 07:00:37 -06:00
Russ Rew
4a6ec72db9 Merge branch 'master' of https://github.com/Unidata/netcdf-c into ncf-314 2014-12-11 14:19:14 -07:00
Ward Fisher
103c0b7f2e The 'Credits' page is now a generated document distributed with netcdf, even though the contents are static. It is currently included as a subpage underneath the NetCDF Overview page. Also, renamed 'Credits' on the Overview page to 'About NetCDF'. 2014-12-10 11:14:43 -07:00
Russ Rew
e2dce0f8f2 Merge branch 'master' of https://github.com/Unidata/netcdf-c into ncf-314 2014-12-10 10:49:44 -07:00
Ward Fisher
fc3d043af1 Merged CMake FAQ into FAQ. 2014-12-09 15:31:07 -07:00
Russ Rew
eaf8ef61e0 resolved conflict 2014-12-09 13:31:20 -07:00
Russ Rew
027f713748 Removed deprecated -k n examples for nccopy and ncgen, fixed ncks examples 2014-12-05 15:32:38 -07:00
Ward Fisher
777dc3e834 Removed a number of syntax errors, dead links in the FAQ. 2014-11-21 15:18:30 -07:00
Nico Schlömer
d23808bd17 remove illegal characters from docs/FAQ.md 2014-08-22 20:30:04 +02:00
Ward Fisher
8479d0733a Migrating manually-maintained FAQ page to a dynamically generated FAQ page. Added the FAQ in markdown format to docs. 2014-07-30 14:11:48 -06:00