Skip navigation links
(CGNS Documentation Home Page) (Steering Committee Charter) (Overview and Entry-Level Document) (A User's Guide to CGNS) (Mid-Level Library) (Standard Interface Data Structures) (SIDS File Mapping Manual) (CGIO User's Guide) (Parallel CGNS User's Guide) (ADF Implementation) (HDF5 Implementation) (Python Implementation) (CGNS Tools and Utilities)

(What's New?) (Join CGNStalk external link) (CGNStalk Archive external link) (Site Maps)

CGNS logo   

CFD General Notation System
Installing HTML Documentation

CGNS Project Group external link

Any or all of the HTML version of the CGNS documentation may be downloaded and installed on a local system. To do so,

  1. Create a parent directory for the documentation (say, "cgns_docs") and cd into it. [These instructions assume a Unix system is being used, since that's what I'm familiar with. Windows PC users will have to do their own translation. Sorry.]

  2. Download each of the following files by clicking on the link while holding down the shift key, assuming your browser supports this capability. A dialogue box will appear for you to specify the directory and file name to be used on your local system. Use the cgns_docs directory you created in step 1, and the file names shown below. Note that an HTML version of the SIDS-to-Python File Mapping Manual is not available yet.

        File Name   Document  
    index.html CGNS Documentation Home Page
    whatsnew.html   "What's New" page
    changes.html   Documentation change history
    aiaa.html   AIAA Recommended Practice
    install_html.html   This page
    cgns.css   External style file
    blank.gif   1x1 blank gif image
    external.png   External link symbol
    charter.tar.gz   Steering Committee Charter
    overview.tar.gz   Overview and Entry-Level Document
    user.tar.gz   User's Guide to CGNS
    midlevel.tar.gz   Mid-Level Library
    sids.tar.gz   Standard Interface Data Structures (SIDS)
    filemap.tar.gz   SIDS File Mapping Manual
    cgio.tar.gz   CGIO User's Guide
    pcgns.tar.gz   Parallel CGNS User's Guide
    adf.tar.gz   ADF Implementation
    hdf5.tar.gz   HDF5 Implementation
    cgnstools.tar.gz   CGNS Tools and Utilities
    logo.tar.gz   CGNS logo
    sitemaps.tar.gz   Documentation Index

  3. Unpack the ".tar.gz" files:
       gunzip -c charter.tar.gz | tar xvf -
       gunzip -c overview.tar.gz | tar xvf -
       gunzip -c user.tar.gz | tar xvf -
       gunzip -c midlevel.tar.gz | tar xvf -
       gunzip -c sids.tar.gz | tar xvf -
       gunzip -c filemap.tar.gz | tar xvf -
       gunzip -c cgio.tar.gz | tar xvf -
       gunzip -c pcgns.tar.gz | tar xvf -
       gunzip -c adf.tar.gz | tar xvf -
       gunzip -c hdf5.tar.gz | tar xvf -
       gunzip -c cgnstools.tar.gz | tar xvf -
       gunzip -c logo.tar.gz | tar xvf -
       gunzip -c sitemaps.tar.gz | tar xvf -

  4. Point your browser to the file index.html in cgns_docs to open the CGNS Documentation Home Page.

Note that this installs only the HTML version of the CGNS documentation. It does not include the other material at the web site, such as the PDF version of the documentation, the conference papers and slide presentations, or the meeting and telecon minutes, or the CGNSTalk archives. Links to those files in the locally-installed CGNS documentation will not work.