-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.html
More file actions
192 lines (163 loc) · 9.6 KB
/
index.html
File metadata and controls
192 lines (163 loc) · 9.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>A Python package for CGNS — intro</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/pycgns.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/pyCGNS-logo-tiny.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="About pyCGNS" href="introduction.html" />
</head><body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="search.html" title="search"
accesskey="S">search</a>
</li>
<li class="right" >
<a href="glossary.html" title="glossary"
accesskey="G">glossary</a>
|</li>
<li class="right" >
<a href="genindex.html" title="General Index"
accesskey="I">index</a>
|</li>
<li class="right" >
<a href="introduction.html" title="About pyCGNS"
accesskey="N">next</a>
|</li>
<li class="right" >
<a href="#" title="pyCGNS top page"
accesskey="M">top</a>
|</li>
<li><a href=#>pyCGNS</a> »</li>
<li class="nav-item nav-item-0"><a href="#">intro</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 align=center><a href="#">
<img class="logo" src="_static/intro-logo-small.png" alt="pyCGNS"/>
</a></h1>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="a-python-package-for-cgns">
<h1>A Python package for CGNS<a class="headerlink" href="#a-python-package-for-cgns" title="Permalink to this headline">¶</a></h1>
Click below for a quick access to modules (DAT module is not available
in this current version).<br>
<div>
<table width="100%" border=2 bordercolor=white>
<tr align="center" valign="middle">
<td align="center" valign="middle"><a href="MAP/_index.html">
<img src="images/MAP-logo-small.png" height="48" alt="MAP"/></a></td>
<td align="center" valign="middle"><a href="PAT/_index.html">
<img src="images/PAT-logo-small.png" height="48" alt="PAT"/></a></td>
<td align="center" valign="middle"><a href="NAV/_index.html">
<img src="images/NAV-logo-small.png" height="48" alt="NAV"/></a></td>
<td align="center" valign="middle"><a href="VAL/_index.html">
<img src="images/VAL-logo-small.png" height="48" alt="VAL"/></a></td>
<td align="center" valign="middle"><a href="APP/_index.html">
<img src="images/APP-logo-small.png" height="48" alt="APP"/></a></td>
</tr></table></div><p>The package gathers various tools and libraries for CGNS end-users and
Python application developpers. The main object of <em>pyCGNS</em> is to
provide the application developpers with a Python interface to
<a class="reference internal" href="glossary.html#term-CGNS-SIDS"><span class="xref std std-term">CGNS/SIDS</span></a>, the CGNS data model. The <a class="reference external" href="http://www.cgns.org">CFD General Notation System
(CGNS)</a> is both a data model for CFD and an
implementation of this data model. CGNS should not be reduced to a
file format, you can use pyCGNS without any file at all for your
actual CFD data!</p>
<div class="sidebar">
<p class="sidebar-title">Release 6.0 (Resume 04/2022)</p>
<ul class="simple">
<li><p>Embedded CHLone (CGNS/HDF5 mapping)</p></li>
<li><p>Python 3 support</p></li>
<li><p>Drop of Python 2 support</p></li>
<li><p>Add compact storage feature</p></li>
<li><p><a class="reference external" href="http://github.com/pyCGNS/pyCGNS">Github repository and tickets</a></p></li>
</ul>
</div>
<p><em>pyCGNS</em> has several sub-modules, some of them are libraries of functions, some other are
tools and some are gathering various scripts and examples.
The <em>MAP</em> and <em>PAT</em> modules are the most important modules, they map the
<a class="reference internal" href="glossary.html#term-CGNS-SIDS"><span class="xref std std-term">CGNS/SIDS</span></a> data model as <a class="reference internal" href="glossary.html#term-CGNS-Python"><span class="xref std std-term">CGNS/Python</span></a> implementation and
provide manipulation function for it.
The <em>NAV</em> module supports the <em>CGNS.NAV</em> graphical browser, with nice
features about tree exploration, copy/paste and even global node changes.
Then, the <em>VAL</em> module is a parser
engine for <a class="reference internal" href="glossary.html#term-CGNS-Python"><span class="xref std std-term">CGNS/Python</span></a> tree compliance
checking. The <em>CGNS.VAL</em> tool can analyze your <a class="reference internal" href="glossary.html#term-CGNS-HDF5"><span class="xref std std-term">CGNS/HDF5</span></a> file
and returns you a list of diagnostics.</p>
<p>The package uses <a class="reference internal" href="glossary.html#term-numpy"><span class="xref std std-term">numpy</span></a>, <a class="reference internal" href="glossary.html#term-cython"><span class="xref std std-term">cython</span></a> and <a class="reference internal" href="glossary.html#term-HDF5"><span class="xref std std-term">HDF5</span></a>
you should install before pyCGNS.
The <em>CGNS.NAV</em> graphical tool uses <a class="reference internal" href="glossary.html#term-Qt"><span class="xref std std-term">Qt</span></a> and has a <a class="reference internal" href="glossary.html#term-VTK"><span class="xref std std-term">VTK</span></a> viewer,
the tool requires the <em>Qt libs</em>, <em>VTK libs</em> and their python interfaces.
The <em>CGNS/SIDS</em> data model has a mapping the <em>HDF5</em> for file storage. The
<em>MAP</em> module uses <a class="reference internal" href="glossary.html#term-CHLone"><span class="xref std std-term">CHLone</span></a> (now embedded into <em>pyCGNS</em>)
instead of <a class="reference internal" href="glossary.html#term-CGNS-MLL"><span class="xref std std-term">CGNS/MLL</span></a> to map its <a class="reference internal" href="glossary.html#term-CGNS-Python"><span class="xref std std-term">CGNS/Python</span></a> trees to <em>HDF5</em>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <em>pyCGNS</em> python package is released
under <a class="reference external" href="http://opensource.org/licenses/lgpl-2.1">LGPL2 license</a> and hosted
by <a class="reference external" href="http://github.com/pyCGNS/pyCGNS">github</a>
where you can find there the
<a class="reference external" href="http://github.com/pyCGNS/pyCGNS/releases">source download</a>.</p>
</div>
<p>The listed chapters are the introduction chapters, each MAP, PAT,
NAV, VAL module has its own documentation which doesn’t appear below.
Click on the modules icons above to get their documentation.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">About pyCGNS</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#cgns-standard">CGNS Standard</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#package-contents">Package contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#quick-start">Quick start</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Build and Install</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#required-libraries">Required libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#installation-process">Installation process</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#single-module-installation">Single module installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#configuration-file-contents">Configuration file contents</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#nav-depends">NAV depends</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#map-depends">MAP depends</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html#test">Test</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
© Copyright 2018-2022, M. P..
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.5.0.
</div>
</body>
</html>