Skip to content

Commit

Permalink
Fixing bullet points on the intro page
Browse files Browse the repository at this point in the history
  • Loading branch information
bryan-harter committed Feb 22, 2022
1 parent 2536222 commit 9b95189
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
10 changes: 5 additions & 5 deletions doc/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ What is cdflib?

cdflib is an effort to replicate the CDF libraries using a pure python implementation. This means users do not need to install the `CDF NASA libraries <https://cdf.gsfc.nasa.gov/>`_.

The only module you need to install is numpy, but there are a few things you can do with astropy and xarray.
The only module you need to install is ``numpy``, but there are a few things you can do with ``astropy`` and ``xarray``.

While this origally started as a way to read PDS-archive compliant CDF files, thanks to many contributors, it has grown to be able to handle every type of CDF file.


What can cdflib do?
-------------------

* Ability to read variables and attributes from CDF files (see `CDF Reader Class`)
* Writes CDF version 3 files (see `CDF Writer Class`)
* Can convert between CDF time types (EPOCH/EPOCH16/TT2000) to other common time formats (see `CDF Time Conversions`)
* Can convert CDF files into XArray Dataset objects and vice versa, attempting to maintain ISTP compliance (see `Working with XArray`)
- Ability to read variables and attributes from CDF files (see ``CDF Reader Class``)
- Writes CDF version 3 files (see ``CDF Writer Class``)
- Can convert between CDF time types (EPOCH/EPOCH16/TT2000) to other common time formats (see ``CDF Time Conversions``)
- Can convert CDF files into XArray Dataset objects and vice versa, attempting to maintain ISTP compliance (see ``Working with XArray``)

.. note::
While we try to simplify things in this documentation, the full API description of each module can be found in the ``API Reference`` section
24 changes: 12 additions & 12 deletions doc/modules/cdfread.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@ cdf_info()

Returns a dictionary that shows the basic CDF information. This information includes

- ``CDF`` the name of the CDF
- ``Version`` the version of the CDF
- ``Encoding`` the endianness of the CDF
- ``Majority`` the row/column majority
- ``zVariables`` a list of the names of the zVariables
- ``rVariables`` a list of the names of the rVariables
- ``Attributes`` a list of dictionary objects that contain attribute names and their scope, ex - {attribute_name : scope}
- ``Checksum`` the checksum indicator
- ``Num_rdim`` the number of dimensions, applicable only to rVariables
- ``rDim_sizes`` the dimensional sizes, applicable only to rVariables
- ``Compressed`` CDF is compressed at the file-level
- ``LeapSecondUpdated`` The last updated for the leap second table, if applicable
- ``CDF`` the name of the CDF
- ``Version`` the version of the CDF
- ``Encoding`` the endianness of the CDF
- ``Majority`` the row/column majority
- ``zVariables`` a list of the names of the zVariables
- ``rVariables`` a list of the names of the rVariables
- ``Attributes`` a list of dictionary objects that contain attribute names and their scope, ex - {attribute_name : scope}
- ``Checksum`` the checksum indicator
- ``Num_rdim`` the number of dimensions, applicable only to rVariables
- ``rDim_sizes`` the dimensional sizes, applicable only to rVariables
- ``Compressed`` CDF is compressed at the file-level
- ``LeapSecondUpdated`` The last updated for the leap second table, if applicable


varinq(variable)
Expand Down

0 comments on commit 9b95189

Please sign in to comment.