Update documentation

docs/source/examples/index.rst

@@ -3,21 +3,26 @@
 Examples
 ========
 
-Gallery of examples:
+Python API
+----------
 
-.. toctree::
-    :maxdepth: 1
-    :caption: Using the Python API
+Compression
+...........
 
-    ./compress_dataset.ipynb
-    ./analyze_dataset.ipynb
-    ./analyze_file.ipynb
-    ./analyze_and_compress_dataset.ipynb
-    ./compress_dataset_without_enstools_write.ipynb
+.. literalinclude:: ../../../examples/python_scripts/compress_dataset.py
+   :language: python
+   :linenos:
 
+Analysis
+........
 
-.. toctree::
-    :maxdepth: 1
-    :caption: Using the Command Line Interface
+.. literalinclude:: ../../../examples/python_scripts/analyze_file.py
+   :language: python
+   :linenos:
 
-    ./compress_file.ipynb
+Analysis and Compression
+........................
+
+.. literalinclude:: ../../../examples/python_scripts/analyze_and_compress_dataset.py
+   :language: python
+   :linenos:

docs/source/user-guide/index.rst

@@ -7,7 +7,7 @@ User Guide
 .. grid:: 1
 
     .. grid-item-card::
-        :columns: 7
+        :columns: 5
 
         .. image:: ../images/icons/api.svg
             :width: 50%
@@ -22,7 +22,7 @@ User Guide
             Using the **Python API**
 
     .. grid-item-card::
-        :columns: 7
+        :columns: 5
 
         .. image:: ../images/icons/cli.svg
             :width: 50%

docs/source/user-guide/using_api.rst

@@ -31,7 +31,7 @@ To analyze a dataset:
 .. code::
 
     from enstools.io import read
-    from enstools.encoding.api import analyze_dataset
+    from enstools.compression.api import analyze_dataset
 
     with read("input.nc") as dataset:
         results = analyze_dataset(dataset)
@@ -40,9 +40,34 @@ To analyze a file:
 
 .. code::
 
-    from enstools.encoding.api import analyze_files
+    from enstools.compression.api import analyze_files
 
     results = analyze_files("input.nc")
 
+Emulator
+........
 
+.. code::
+
+    from enstools.io import read
+    from enstools.encoding.api import emulate_compression_on_dataset
+
+
+    results = analyze_files("input.nc")
+    with read("input.nc") as dataset:
+        compressed_dataset = emulate_compression_on_dataset(dataset, compression="lossy,sz,pw_rel,1e-5", inplace=False)
+
+        diff = compressed_dataset - dataset
 
+
+
+xarray accessor
+...............
+
+.. code::
+
+    from enstools.io import read
+    import enstools.compression.xr_accessor
+
+    with read("input.nc") as dataset:
+        results = dataset.compression.analyze()