PySpectra documentation

PySpectra is self documenting. All you have to remember is this:

 

In [1]: import PySpectra
In [2]: PySpectra?

The idea is to keep the online documentation up to date. To give you an impression of what you will have to expect, here is the output date from September 2nd, 2021:

 

PySpectra displays 1D and 2D data
---------------------------------
*
* Applications based on PySpectra: 
* --------------------------------
*

$ pyspMonitor.py
  - listens to a Sardana Door and displays 0D and 1D data
  - receives data and commands sent by PySpectra.toPyspMonitor()
  - has the displayCounters feature, see the Sardana/Spock/Taurus at DESY manual
  - uses the SignalCounter to display the a signal during mesh scans.

$ TngGui.py
  gives access to various parts of our Tango/Sardana environment

$ pyspViewer.py 
  displays 1D data from ASCII (.fio, .dat,. iint) and .nxs files

*
* toPyspMonitor() 
* sends data and commands to one or more pyspMonitor processes.
* Help can be found with:
*
  In [1]: import PySpectra
  In [2]: PySpectra.toPyspMonitor?
*
* toPyspLocal()
* Use the same syntax as in toPyspMonitor() but plot in the 
* local process
*
  In [3]: PySpectra.toPyspLocal?

*
* PySpectra Python interface in general
* -------------------------------------
*
Start by executing some examples using pyspViewer->Examples.
Afterwards you see how it was done by looking at the code
  pyspViewer->Examples->View Code

In addition, all PySpectra functions and modules are python-documented

  import PySpectra 
  In [1]: import PySpectra
  In [2]: PySpectra?
  In [3]: PySpectra.Scan?
  In [4]: PySpectra.Image?

*
* PySpectra magic commands in ipython:
* -----------------------------------
*  
In [1]: import PySpectra.ipython.startup
In [2]: PySpectra.ipython.startup?