Skip to content

Commit 9ccca33

Browse files
wkliaowkliao
committed
doc: rewording
1 parent 8ed6d14 commit 9ccca33

File tree

10 files changed

+121
-118
lines changed

10 files changed

+121
-118
lines changed

‎docs/source/api/attribute_api.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
===========
2-
Attribute
2+
Attributes
33
===========
44

5-
In the library, netCDF attributes can be created, accessed, and manipulated
6-
using python dictionary-like syntax. A Pythonic interface for metadata operations
7-
is provided both in the ``File`` class (for global attributes) and the
8-
``Variable`` class (for variable attributes).
5+
NetCDF attributes can be created, accessed, and manipulated using python
6+
dictionary-like syntax. An attribute can be associated to the file, referred to
7+
as ``golbal attribute``, as well as to individual variable, referred to as
8+
``variable's attribute``. Pythonic interfaces for accessing attributes are is
9+
provided both in :class:`pnetcdf.File` (for global attributes) and the
10+
:class:`pnetcdf.Variable` (for variable attributes).
11+

‎docs/source/api/dimension_api.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
==============
2-
Dimension
2+
Dimensions
33
==============
44

5-
Dimension defines the shape and structure of variables and stores coordinate
6-
data for multidimensional arrays. The ``Dimension`` object, which is also a key
7-
component of ``File`` class, provides an interface to access dimensions.
5+
Class ``Dimension`` is used to define the shape of NetCDF variables. In NetCDF,
6+
a variable, an instance of :class:`pnetcdf.Variable`, is a multi-dimensional
7+
array. Methods in :class:`pnetcdf.Dimension` provide an interface to access
8+
dimensions objects stored in the file.
89

910
.. autoclass:: pnetcdf::Dimension
1011
:members: getfile, isunlimited
@@ -24,7 +25,8 @@ Read-only Python Attributes of Dimension Class
2425

2526
.. attribute:: size
2627

27-
The current size of Dimension (calls ``len`` on Dimension instance).
28+
The current size of Dimension (its value can be obtained by calling
29+
python function ``len()`` on the Dimension instance).
2830

2931
**Type:** `int`
3032

‎docs/source/api/file_api.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
================
2-
File
2+
Files
33
================
44

5-
``pnetcdf.File`` is a high-level object representing an netCDF file,
6-
which provides a Pythonic interface to create, read and write within
7-
an netCDF file. A File object serves as the root container for dimensions,
8-
variables, and attributes. Together they describe the meaning of data and
9-
relations among data fields stored in a netCDF file.
5+
An instance of class ``pnetcdf.File`` is a high-level object representing a
6+
netCDF file. The class methods provide a set of Pythonic interfaces to create,
7+
read and write a netCDF file. A ``File`` instance serves as the root container
8+
for dimensions, variables, and attributes. Together they describe the meaning
9+
of data and relations among data objects stored in a netCDF file.
1010

1111
.. autoclass:: pnetcdf::File
1212
:members: __init__, close, filepath, redef, enddef, begin_indep, end_indep,
@@ -24,14 +24,14 @@ Read-only Python Attributes of File Class
2424
.. attribute:: dimensions
2525

2626
The dimensions dictionary maps the names of dimensions defined in this
27-
file as an instance of the ``pnetcdf.Dimension`` class.
27+
file as an instance of the :class:`pnetcdf.Dimension`.
2828

2929
**Type:** `dict`
3030

3131
.. attribute:: variables
3232

3333
The variables dictionary maps the names of variables defined in this file
34-
as an instance of the ``pnetcdf.Variable`` class.
34+
as an instance of the :class:`pnetcdf.Variable`.
3535

3636
**Type:** `dict`
3737

‎docs/source/api/function_api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
================
2-
Utility Functions
2+
Other PnetCDF Utility Functions
33
================
44

55
.. autofunction:: pnetcdf::libver

‎docs/source/api/variable_api.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
=========
2-
Variable
2+
Variables
33
=========
44

5-
Variable is a core component of a netCDF file representing an array of data
5+
``Variable`` is a core component of a netCDF file representing an array of data
66
values organized along one or more dimensions, with associated metadata in the
7-
form of attributes. The ``Variable`` object in the library provides operations
8-
to read and write the data and metadata of a variable within a netCDF file.
9-
Particularly, data mode operations have a flexible interface, where reads and
10-
writes can be done through either explicit function-call style methods or
11-
indexer-style (numpy-like) syntax.
7+
form of attributes. An instance of class :class:`pnetcdf.Variable` represents a
8+
NetCDF variable stored in the file. The class methods provide I/O operations to
9+
read and write the data and metadata of a NetCDF variable.
10+
11+
Reading and writing a subarray of a variable can be done through either
12+
explicit function-call style methods or Python indexer-style (numpy-like)
13+
syntax.
1214

1315
.. autoclass:: pnetcdf::Variable
1416
:members: ncattrs, put_att, get_att, del_att, rename_att, get_dims,

‎docs/source/copyright.rst

Lines changed: 31 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,35 @@
1-
================
2-
Copyright Statement
3-
================
1+
Copyright (c) 2024 Northwestern University and Argonne National Laboratory All
2+
rights reserved.
43

5-
::
4+
Portions of this software were developed by the Unidata Program at the
5+
University Corporation for Atmospheric Research.
66

7-
Copyright (c) 2024 Northwestern University and Argonne National
8-
Laboratory All rights reserved.
7+
Access and use of this software shall impose the following obligations and
8+
understandings on the user. The user is granted the right, without any fee or
9+
cost, to use, copy, modify, alter, enhance and distribute this software, and
10+
any derivative works thereof, and its supporting documentation for any purpose
11+
whatsoever, provided that this entire notice appears in all copies of the
12+
software, derivative works and supporting documentation. Further, Northwestern
13+
University and Argonne National Laboratory request that the user credit
14+
Northwestern University and Argonne National Laboratory in any publications
15+
that result from the use of this software or in any product that includes this
16+
software. The names Northwestern University and Argonne National Laboratory,
17+
however, may not be used in any advertising or publicity to endorse or promote
18+
any products or commercial entity unless specific written permission is
19+
obtained from Northwestern University and Argonne National Laboratory. The user
20+
also understands that Northwestern University and Argonne National Laboratory
21+
are not obligated to provide the user with any support, consulting, training or
22+
assistance of any kind with regard to the use, operation and performance of
23+
this software nor to provide the user with any updates, revisions, new versions
24+
or "bug fixes."
925

10-
Portions of this software were developed by the Unidata Program at the
11-
University Corporation for Atmospheric Research.
12-
13-
Access and use of this software shall impose the following obligations and
14-
understandings on the user. The user is granted the right, without any fee
15-
or cost, to use, copy, modify, alter, enhance and distribute this software,
16-
and any derivative works thereof, and its supporting documentation for any
17-
purpose whatsoever, provided that this entire notice appears in all copies
18-
of the software, derivative works and supporting documentation. Further,
19-
Northwestern University and Argonne National Laboratory request that the
20-
user credit Northwestern University and Argonne National Laboratory in any
21-
publications that result from the use of this software or in any product
22-
that includes this software. The names Northwestern University and Argonne
23-
National Laboratory, however, may not be used in any advertising or
24-
publicity to endorse or promote any products or commercial entity unless
25-
specific written permission is obtained from Northwestern University and
26-
Argonne National Laboratory. The user also understands that Northwestern
27-
University and Argonne National Laboratory are not obligated to provide the
28-
user with any support, consulting, training or assistance of any kind with
29-
regard to the use, operation and performance of this software nor to
30-
provide the user with any updates, revisions, new versions or "bug fixes."
31-
32-
THIS SOFTWARE IS PROVIDED BY NORTHWESTERN UNIVERSITY AND ARGONNE NATIONAL
33-
LABORATORY "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
34-
NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
35-
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NORTHWESTERN
36-
UNIVERSITY AND ARGONNE NATIONAL LABORATORY BE LIABLE FOR ANY SPECIAL,
37-
INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
38-
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
39-
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE ACCESS,
40-
USE OR PERFORMANCE OF THIS SOFTWARE.
26+
THIS SOFTWARE IS PROVIDED BY NORTHWESTERN UNIVERSITY AND ARGONNE NATIONAL
27+
LABORATORY "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
29+
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NORTHWESTERN UNIVERSITY
30+
AND ARGONNE NATIONAL LABORATORY BE LIABLE FOR ANY SPECIAL, INDIRECT OR
31+
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
32+
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
33+
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE ACCESS, USE OR PERFORMANCE OF
34+
THIS SOFTWARE.
4135

‎docs/source/index.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,17 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
PnetCDF-Python Documentation
6+
PnetCDF-Python User Guide
77
============================
88

99
**Release:** |release|
1010

11-
.. toctree::
12-
:maxdepth: 2
13-
:caption: Introduction
14-
15-
introduction/overview
11+
PnetCDF-python is a Python interface to PnetCDF, a high-performance parallel
12+
I/O library for accessing netCDF files. This integration with Python allows
13+
for easy manipulation, analysis, and visualization of netCDF data using the
14+
rich ecosystem of Python's scientific computing libraries, making it a valuable
15+
tool for python-based applications that require high-performance access to
16+
netCDF files.
1617

1718
.. toctree::
1819
:maxdepth: 2
@@ -32,11 +33,12 @@ PnetCDF-Python Documentation
3233

3334
.. toctree::
3435
:maxdepth: 3
35-
:caption: API Documentation
36+
:caption: API Reference
3637

3738
api/file_api
3839
api/dimension_api
3940
api/variable_api
41+
api/attribute_api
4042
api/function_api
4143

4244
.. toctree::

0 commit comments

Comments
 (0)