mirror/netcdf-c
2
0
Fork 0
mirror of https://github.com/Unidata/netcdf-c.git synced 2025-04-06 18:00:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs cleanup

Browse Source
This commit is contained in:
Jennifer Oxelson 2021-11-11 11:40:45 -07:00
parent 5b7ddcca06
commit f7e3d3e44f
9 changed files with 27 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -47,7 +47,7 @@ software for various languages:
* [C library and utilities](http://github.com/Unidata/netcdf-c)
* [Fortran](http://github.com/Unidata/netcdf-fortran)
* [Java](https://www.unidata.ucar.edu/downloads/netcdf-java/
* [Java](https://downloads.unidata.ucar.edu/netcdf-java/)
* [Python](http://github.com/Unidata/netcdf4-python)
* [C++](http://github.com/Unidata/netcdf-cxx4)
@ -64,11 +64,11 @@ netCDF-C distribution, or the (usually more up-to-date) document:
A language-independent User's Guide for netCDF, and some other
language-specific user-level documents are available from:
* [Language-independent User's Guide](https://www.unidata.ucar.edu/software/netcdf/documentation/NUG/index.html#user_guide)
* [Language-independent User's Guide](https://docs.unidata.ucar.edu/nug/current/index.html#user_guide)
* [NetCDF-C Tutorial](https://docs.unidata.ucar.edu/netcdf-c/current/tutorial_8dox.html)
* [Fortran-90 User's Guide](https://www.unidata.ucar.edu/software/netcdf/documentation/historic/netcdf-f90/index.html#Top)
* [Fortran-77 User's Guide](https://www.unidata.ucar.edu/software/netcdf/documentation/historic/netcdf-f77/index.html#Top)
* [netCDF-Java/Common Data Model library](https://docs.unidata.ucar.edu/netcdf-java/current/userguide/index.html)
* [Fortran-90 User's Guide](https://docs.unidata.ucar.edu/netcdf-fortran/current/f90_The-NetCDF-Fortran-90-Interface-Guide.html)
* [Fortran-77 User's Guide](https://docs.unidata.ucar.edu/netcdf-fortran/current/nc_f77_interface_guide.html)
* [netCDF-Java/Common Data Model library](https://docs.unidata.ucar.edu/netcdf-java/current/userguide/)
* [netCDF4-python](http://unidata.github.io/netcdf4-python/)
A mailing list, netcdfgroup@unidata.ucar.edu, exists for discussion of

2
docs/Doxyfile.in
View File

@ -2037,7 +2037,7 @@ SKIP_FUNCTION_MACROS = YES
# TAGFILES = html/guide.tag=./html_guide "html/tutorial.tag = ./html_tutorial"
#TAGFILES = ../../NUG/html/nug.tag=../../../NUG/html
TAGFILES = ../../NUG/html/nug.tag=https://www.unidata.ucar.edu/software/netcdf/documentation/NUG
TAGFILES = ../../NUG/html/nug.tag=https://docs.unidata.ucar.edu/nug
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to

2
docs/Doxyfile.user
View File

@ -2060,7 +2060,7 @@ SKIP_FUNCTION_MACROS = YES
# TAGFILES = html/guide.tag=./html_guide "html/tutorial.tag = ./html_tutorial"
#TAGFILES = ../../NUG/html/nug.tag=../../../NUG/html
#TAGFILES = ../../NUG/html/nug.tag=https://www.unidata.ucar.edu/software/netcdf/documentation/NUG
#TAGFILES = ../../NUG/html/nug.tag=https://docs.unidata.ucar.edu/nug
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to

8
docs/FAQ.md
View File

@ -46,7 +46,7 @@ How do I get the netCDF software package? {#HowdoIgetthenetCDFsoftwarepackage}
The latest source distribution, which includes the C libraries and
utility programs, is available from [the NetCDF Downloads
page](/downloads/netcdf/index.jsp). Separate source distributions for
page](https://downloads.unidata.ucar.edu/netcdf-c). Separate source distributions for
the Java library, Fortran libraries, and C++ libraries are also
available there. Installation instructions are available with the
distribution or [online](https://docs.unidata.ucar.edu/netcdf-c/current/building.html).
@ -139,8 +139,8 @@ attributes; what order to use for the dimensions of multidimensional
variables; what variables to include in the same netCDF file; and how to
use variable attributes to capture the structure and meaning of data. We
provide some guidelines in the NetCDF User's Guide (e.g., the section on
[Differences between Attributes and Variables](https://www.unidata.ucar.edu/software/netcdf/documentation/NUG/netcdf_data_set_components.html#differences_atts_vars))
and in a new web document [Writing NetCDF Files: BestPractices](https://www.unidata.ucar.edu/software/netcdf/documentation/NUG/_best_practices.html), but we've found that
[Differences between Attributes and Variables](https://docs.unidata.ucar.edu/nug/current/netcdf_data_set_components.html#differences_atts_vars))
and in a new web document [Writing NetCDF Files: BestPractices](https://docs.unidata.ucar.edu/nug/current/_best_practices.html), but we've found that
a little experience helps. Occasionally we have decided it was useful to
change the structure of netCDF files after experience with how the data
is used.
@ -401,7 +401,7 @@ support. The announcement of the availability of that port is
[here](https://www.unidata.ucar.edu/mailing_lists/archives/netcdfgroup/2011/msg00363.html).
User Veit Eitner has contributed a port of 4.1.1 to Visual Studio,
including an F90 port to Intel Fortran. Download [source (ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-4.1.1-win32-src.zip)](ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-4.1.1-win32-src.zip) or [binary](ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-4.1.1-win32-bin.zip) versions. This port was done before the code was refactored in 4.1.2.
including an F90 port to Intel Fortran. Download [source (ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-4.1.1-win32-src.zip)](ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-4.1.1-win32-src.zip) or [binary](https://downloads.unidata.ucar.edu/netcdf-c) versions. This port was done before the code was refactored in 4.1.2.
How can I use netCDF-4 with Windows? {#How-can-I-use-netCDF-4-with-Windows}
-----------------

3
docs/known_problems.md
View File

@ -138,8 +138,7 @@ in the error message
NetCDF: Malformed or inaccessible DAP DDS
This bug is fixed in 4.2 releases after 2011-09-11, as well as by fixing
the 4.1.3 release using the 3 replacement source files in [this tar
file](https://www.unidata.ucar.edu/downloads/netcdf/ftp/4.1.3-fix.tar).
the 4.1.3 release using the 3 replacement source files in the 4.1.3-fix.tar file.
### Configuring with "--enable-benchmarks" option

5
docs/mainpage.dox
View File

@ -18,7 +18,7 @@ You can find the documentation for netCDF-Fortran here:
\section this_release Learn more about the current NetCDF-C Release
- \subpage RELEASE_NOTES
- <A href="https://www.unidata.ucar.edu/software/netcdf/documentation/NUG/getting_and_building_netcdf.html">Getting and Building NetCDF</A>
- <A href="https://docs.unidata.ucar.edu/nug/current/getting_and_building_netcdf.html">Getting and Building NetCDF</A>
\subsection nightly_status The Latest NetCDF Build Status
@ -36,9 +36,8 @@ You can find the documentation for netCDF-Fortran here:
\section learn-more Learn more about using NetCDF-C
- \ref sec_tut
- <A href="https://www.unidata.ucar.edu/software/netcdf/documentation/NUG/">The netCDF User's Guide</A>
- <A href="https://docs.unidata.ucar.edu/nug/">The netCDF User's Guide</A>
- \ref netcdf_working_with_netcdf_files
- <a class="el" href="https://www.unidata.ucar.edu/software/netcdf/documentation/historic/">Older Documentation, plus details regarding netcdf-fortran and netcdf-cxx.</a>
\section netcdf-cmake-windows NetCDF CMake and Windows support:
- \ref netCDF-CMake

3
docs/old/defines.texi
View File

@ -24,6 +24,7 @@
@c Home pages for internal stuff like netcdf, netcdf-4, netcdf java,
@c Unidata, etc.
@set unidata-url https://www.unidata.ucar.edu
@set download-url https://downloads.unidata.ucar.edu
@set netcdf-url @value{unidata-url}/netcdf
@set netcdf-4-url @value{netcdf-url}/netcdf-4
@set netcdf-java-url @value{unidata-url}/software/netcdf-java
@ -73,7 +74,7 @@
@c places to get downloads
@set ftp-site ftp://ftp.unidata.ucar.edu/pub/netcdf
@set netcdf4-ftp-site @value{ftp-site}/netcdf-4
@set netcdf-binaries-url @value{unidata-url}/downloads/netcdf/index.jsp
@set netcdf-binaries-url @value{download-url}/netcdf
@set windows-ftp-site @value{ftp-site}/contrib/win32
@c Tools mentioned in the netCDF tutorial.

17
docs/release_header.html
View File

@ -8,7 +8,7 @@
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="https://www.unidata.ucar.edu/js/jquery/jquery-latest.min.js"></script>
<script type="text/javascript" src="https://docs.unidata.ucar.edu/js/jquery/jquery-latest.min.js"></script>
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
@ -17,22 +17,11 @@ $mathjax
$extrastylesheet
<script type="text/javascript">
$( document ).ready(function() {
var $searchForm = "<form name=\"google\" action=\"https://www.unidata.ucar.edu/search.jsp\" id=\"cse-search-box\">" +
" <input type=\"hidden\" name=\"locationName\" value=\"NetCDF Documentation\"></input>" +
" <input type=\"hidden\" name=\"hq\" value=\"site:www.unidata.ucar.edu/software/netcdf/docs\"></input>" +
" <input type=\"hidden\" name=\"cx\" value=\"008424664622949020059:afj38jxaljc\"></input>" +
" <input type=\"hidden\" name=\"cof\" value=\"FORID:9\"></input>" +
" <input type=\"hidden\" name=\"ie\" value=\"UTF-8\"></input>" +
" <input type=\"text\" autocomplete=\"on\" name=\"q\" maxlength=\"255\" id=\"search\"></input>" +
" <input type=\"submit\" name=\"sa\" value=\"search\" id=\"form_submit\"></input>" +
"</form>";
var $searchForm = "";
var $linkMenu = "<select id=\"versions\">" +
" <option value=\"https://docs.unidata.ucar.edu/netcdf-c\">Current</option>" +
" <option value=\"https://www.unidata.ucar.edu/software/netcdf/documentation/4.4.1.1\">4.4.1.1</option>" +
" <option value=\"https://www.unidata.ucar.edu/software/netcdf/documentation/4.4.1\">4.4.1</option>" +
" <option value=\"https://www.unidata.ucar.edu/software/netcdf/documentation/4.4.0\">4.4.0</option>" +
" <option value=\"https://www.unidata.ucar.edu/software/netcdf/documentation/historic\">Historic Documentation</option>" +
" <option value=\"https://docs.unidata.ucar.edu/netcdf-c/4.8.1.">4.8.1</option>" +
"</select>";
$("#navrow1 ul.tablist").append('<li class=\"linkMenu\"><span class="tab">' + $linkMenu + '</span></li>');

16
docs/windows-binaries.md
View File

@ -60,11 +60,11 @@ When installed, the netCDF libraries are placed in the specified locations, alon
1. 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]
[r1]: https://downloads.unidata.ucar.edu/netcdf-c//major.minor.point/windows_installers/netCDFmajor.minor.point-NC3-32.exe
[r2]: https://downloads.unidata.ucar.edu/netcdf-c//major.minor.point/windows_installers/netCDFmajor.minor.point-NC3-DAP-32.exe
[r3]: https://downloads.unidata.ucar.edu/netcdf-c//major.minor.point/windows_installers/netCDFmajor.minor.point-NC4-32.exe
[r4]: https://downloads.unidata.ucar.edu/netcdf-c//major.minor.point/windows_installers/netCDFmajor.minor.point-NC4-DAP-32.exe
[r5]: https://downloads.unidata.ucar.edu/netcdf-c//major.minor.point/windows_installers/netCDFmajor.minor.point-NC3-64.exe
[r6]: https://downloads.unidata.ucar.edu/netcdf-c//major.minor.point/windows_installers/netCDFmajor.minor.point-NC3-DAP-64.exe
[r7]: https://downloads.unidata.ucar.edu/netcdf-c//major.minor.point/windows_installers/netCDFmajor.minor.point-NC4-64.exe
[r8]: https://downloads.unidata.ucar.edu/netcdf-c//major.minor.point/windows_installers/netCDFmajor.minor.point-NC4-DAP-64.exe
[r1]: https://downloads.unidata.ucar.edu/netcdf-c/major.minor.point/windows_installers/netCDFmajor.minor.point-NC3-32.exe
[r2]: https://downloads.unidata.ucar.edu/netcdf-c/major.minor.point/windows_installers/netCDFmajor.minor.point-NC3-DAP-32.exe
[r3]: https://downloads.unidata.ucar.edu/netcdf-c/major.minor.point/windows_installers/netCDFmajor.minor.point-NC4-32.exe
[r4]: https://downloads.unidata.ucar.edu/netcdf-c/major.minor.point/windows_installers/netCDFmajor.minor.point-NC4-DAP-32.exe
[r5]: https://downloads.unidata.ucar.edu/netcdf-c/major.minor.point/windows_installers/netCDFmajor.minor.point-NC3-64.exe
[r6]: https://downloads.unidata.ucar.edu/netcdf-c/major.minor.point/windows_installers/netCDFmajor.minor.point-NC3-DAP-64.exe
[r7]: https://downloads.unidata.ucar.edu/netcdf-c/major.minor.point/windows_installers/netCDFmajor.minor.point-NC4-64.exe
[r8]: https://downloads.unidata.ucar.edu/netcdf-c/major.minor.point/windows_installers/netCDFmajor.minor.point-NC4-DAP-64.exe