File: index.rst

package info (click to toggle)
python-sidpy 0.12.3-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 21,988 kB
  • sloc: python: 11,456; makefile: 17
file content (57 lines) | stat: -rw-r--r-- 1,311 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
.. SIDpy documentation master file, created by
   sphinx-quickstart on Sun Jul 12 16:57:01 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

sidpy
=====

**Python utilities for storing, visualizing, and processing Spectroscopic and Imaging Data (SID)**

This utilities package supports other packages such as:

* Data formatting:

  * `pyNSID <https://pycroscopy.github.io/pyNSID/about.html>`_
  * `pyUSID <https://pycroscopy.github.io/pyUSID/about.html>`_

* Scientific analysis:

  * `pycroscopy <https://pycroscopy.github.io/pycroscopy/about.html>`_
  * `ScopeReaders <https://pycroscopy.github.io/ScopeReaders/about.html>`_
  * `BGlib <https://pycroscopy.github.io/BGlib/about.html>`_

Please use the side panel on the left for other documentation pages on ``sidpy``

Jump to our `GitHub project page <https://github.com/pycroscopy/sidpy>`_

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: SIDpy

   install
   getting_started
   external_guides
   contribute
   matlab
   contact


Source code API
---------------
.. autosummary::
   :toctree: _autosummary
   :template: custom-module-template.rst
   :recursive:

   sidpy

* :ref:`modindex`

.. toctree::
   :glob:
   :maxdepth: 2
   :caption: Examples

   notebooks/**/index