index.rst 1.52 KB
Newer Older
1
.. pycroscopy documentation master file, created by
Chris Smith's avatar
Chris Smith committed
2
   sphinx-quickstart on Thu Jul 20 11:56:03 2017.
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pycroscopy's documentation!
======================================
0. Description
--------------
A python package for image processing and scientific analysis of imaging modalities such as multi-frequency scanning probe microscopy,
scanning tunneling spectroscopy, x-ray diffraction microscopy, and transmission electron microscopy.
Classes implemented here are ported to a high performance computing platform at Oak Ridge National Laboratory (ORNL).

1. Package Structure
--------------------
The package structure is simple, with 4 main modules:
   1. `io`: Input/Output from custom & proprietary microscope formats to HDF5.
   2. `processing`: Multivariate Statistics, Machine Learning, and Filtering.
   3. `analysis`: Model-dependent analysis of image information.
   4. `viz`: Visualization and interactive slicing of high-dimensional data by lightweight Qt viewers.

Once a user converts their microscope's data format into an HDF5 format, by simply extending some of the classes in `io`, the user gains access to the rest of the utilities present in `pycroscopy.*`.

.. toctree::
Chris Smith's avatar
Chris Smith committed
25
26
   :maxdepth: 4
   :caption: Contents:
27

Chris Smith's avatar
Chris Smith committed
28
29
30
31
32
   pycroscopy.analysis
   pycroscopy.io
   pycroscopy.processing
   pycroscopy.tests
   pycroscopy.viz
nlaanait's avatar
nlaanait committed
33

34

Chris Smith's avatar
Chris Smith committed
35
36
Indices and tables
==================
37

Chris Smith's avatar
Chris Smith committed
38
39
40
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`