Adding a few pages to the documentation

MAVENSDC · Feb 9, 2022 · 36d0a9e · 36d0a9e
1 parent 99b5076
commit 36d0a9e
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 0 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -18,10 +18,13 @@ cdflib requires python 3 and numpy. To install run
    :maxdepth: 2
    :caption: Contents:
 
+   introduction
    modules/cdfread
    modules/cdfwrite
    modules/epochs
    modules/epochs_astropy
+   modules/cdf_to_xarray
+   modules/xarray_to_cdf
 
 
 

diff --git a/doc/introduction.rst b/doc/introduction.rst
@@ -0,0 +1,19 @@
+Introduction
+===================
+
+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 libraries.  
+
+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 does it do?
+-------------------
+
+* Ability to read variables and attributes from CDF files
+* Can write CDF files
+* Can convert between CDF time types and other common time formats
+* Can convert CDF files into XArray Dataset objects
+* Can convert XArray Dataset objects into CDF files, attempting to maintain ISTP compliance 
diff --git a/doc/modules/cdf_to_xarray.rst b/doc/modules/cdf_to_xarray.rst
diff --git a/doc/modules/xarray_to_cdf.rst b/doc/modules/xarray_to_cdf.rst