* BeamTilt/BeamShift

* Documentation update * renamed source directory from _temscript to _temscript_module
niermann · Mar 24, 2017 · ecc169f · ecc169f
1 parent 54b8354
commit ecc169f
Show file tree

Hide file tree

Showing 34 changed files with 315 additions and 214 deletions.
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
@@ -1,3 +1,7 @@
+-- Version 1.0.7 --------------------------------------------
+
+Started new interface (with client/server support).
+
 -- Version 1.0.5 --------------------------------------------
 
 Small fixes

diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2012-2016, Tore Niermann
+Copyright (c) 2012-2017, Tore Niermann
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/README.txt b/README.txt
@@ -21,6 +21,8 @@ Requirements:
     Numpy (tested with 1.6)
     Sphinx (only for building documentation, tested with 1.1.3)
     A compiler (tested with MS Visual Studio 8/10)
+    FEI Microscope's scripting adapter DLL. On a Titan V1.1 PC typically located in
+        C:\Titan\Scripting\stdscript.dll
 
 Alternatively, use the Anaconda python distribution (you still need
 the compiler though)
@@ -29,7 +31,7 @@ the compiler though)
 
 Install your own microscope's scripting adapters type library:
     1) Copy your version of the scripting adapter's stdscript.dll into 
-    to the _temscript subdirectory
+    to the _temscript_module subdirectory
 
 Simply execute from the command line (assuming you have your python 
 interpreter in the path):
@@ -67,7 +69,7 @@ Relative to Titan V1.1 scripting adapter:
 
 -- Copyright & Disclaimer -----------------------------------------
 
-Copyright (c) 2012-2016 by Tore Niermann
+Copyright (c) 2012-2017 by Tore Niermann
 Contact: niermann (at) physik.tu-berlin.de
 
 All product and company names are trademarks or registered trademarks 

diff --git a/_temscript/acqimage.cpp → _temscript_module/acqimage.cpp b/_temscript/acqimage.cpp → _temscript_module/acqimage.cpp
diff --git a/_temscript/acquisition.cpp → _temscript_module/acquisition.cpp b/_temscript/acquisition.cpp → _temscript_module/acquisition.cpp
diff --git a/_temscript/blankershutter.cpp → _temscript_module/blankershutter.cpp b/_temscript/blankershutter.cpp → _temscript_module/blankershutter.cpp
diff --git a/_temscript/ccdacqparams.cpp → _temscript_module/ccdacqparams.cpp b/_temscript/ccdacqparams.cpp → _temscript_module/ccdacqparams.cpp
diff --git a/_temscript/ccdcamera.cpp → _temscript_module/ccdcamera.cpp b/_temscript/ccdcamera.cpp → _temscript_module/ccdcamera.cpp
diff --git a/_temscript/ccdcamerainfo.cpp → _temscript_module/ccdcamerainfo.cpp b/_temscript/ccdcamerainfo.cpp → _temscript_module/ccdcamerainfo.cpp
diff --git a/_temscript/configuration.cpp → _temscript_module/configuration.cpp b/_temscript/configuration.cpp → _temscript_module/configuration.cpp
diff --git a/_temscript/defines.h → _temscript_module/defines.h b/_temscript/defines.h → _temscript_module/defines.h
diff --git a/_temscript/gauge.cpp → _temscript_module/gauge.cpp b/_temscript/gauge.cpp → _temscript_module/gauge.cpp
diff --git a/_temscript/gun.cpp → _temscript_module/gun.cpp b/_temscript/gun.cpp → _temscript_module/gun.cpp
diff --git a/_temscript/illumination.cpp → _temscript_module/illumination.cpp b/_temscript/illumination.cpp → _temscript_module/illumination.cpp
diff --git a/_temscript/instrument.cpp → _temscript_module/instrument.cpp b/_temscript/instrument.cpp → _temscript_module/instrument.cpp
diff --git a/_temscript/instrumentmodecontrol.cpp → _temscript_module/instrumentmodecontrol.cpp b/_temscript/instrumentmodecontrol.cpp → _temscript_module/instrumentmodecontrol.cpp
diff --git a/_temscript/module.cpp → _temscript_module/module.cpp b/_temscript/module.cpp → _temscript_module/module.cpp
diff --git a/_temscript/projection.cpp → _temscript_module/projection.cpp b/_temscript/projection.cpp → _temscript_module/projection.cpp
diff --git a/_temscript/stage.cpp → _temscript_module/stage.cpp b/_temscript/stage.cpp → _temscript_module/stage.cpp
diff --git a/_temscript/stemacqparams.cpp → _temscript_module/stemacqparams.cpp b/_temscript/stemacqparams.cpp → _temscript_module/stemacqparams.cpp
diff --git a/_temscript/stemdetector.cpp → _temscript_module/stemdetector.cpp b/_temscript/stemdetector.cpp → _temscript_module/stemdetector.cpp
diff --git a/_temscript/stemdetectorinfo.cpp → _temscript_module/stemdetectorinfo.cpp b/_temscript/stemdetectorinfo.cpp → _temscript_module/stemdetectorinfo.cpp
diff --git a/_temscript/temscript.h → _temscript_module/temscript.h b/_temscript/temscript.h → _temscript_module/temscript.h
diff --git a/_temscript/types.h → _temscript_module/types.h b/_temscript/types.h → _temscript_module/types.h
diff --git a/_temscript/vacuum.cpp → _temscript_module/vacuum.cpp b/_temscript/vacuum.cpp → _temscript_module/vacuum.cpp
diff --git a/doc/conf.py b/doc/conf.py
@@ -25,7 +25,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
+extensions = ['sphinx.ext.autodoc']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -41,7 +41,7 @@
 
 # General information about the project.
 project = u'temscript'
-copyright = u'2012-2016, Tore Niermann'
+copyright = u'2012-2017, Tore Niermann'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -50,7 +50,7 @@
 # The short X.Y version.
 version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.0.6'
+release = '1.0.7'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/doc/index.rst b/doc/index.rst
@@ -4,9 +4,10 @@ Welcome to temscript's documentation!
 Contents:
 
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 2
 
-   module
+    microscope
+    instrument
 
 Introduction:
 =============
@@ -25,7 +26,9 @@ Enumerations
 Many of the object's attributes actually return values from enumeration. The Python
 wrappers of these attributes will return an integer value. There are constants in the
 :mod:`temscript` module representing the enumeration values (e.g. ``pmImaging`` and ``pmDiffraction``
-for the ``Mode`` attribute of the :class:`Projection` object)
+for the ``Mode`` attribute of the :class:`Projection` object). Since version 1.0.5 there are also
+python enums for these, which can be found in the :mod:`temscript.enums` module and are imported
+into the :mod:`temscript` namespace.
 
 Vectors
 ^^^^^^^
@@ -40,6 +43,15 @@ Collections
 Collections will be returned as list or tuple of objects. In future versions this might change,
 and dictionaries will be returned.
 
+Globals
+^^^^^^^
+
+.. data:: version
+
+    A string describing the version of temscript in the format 'X.Y.Z'.
+    Current value is '|release|'. This is not the version of the TEMScripting interface
+    (which can't be queried such easily).
+
 Indices and tables
 ==================