From 1e2904bb88b7f14b6890ee466e0034cfa1db04fd Mon Sep 17 00:00:00 2001 From: Aaron Ponti Date: Fri, 10 Dec 2021 17:37:22 +0100 Subject: [PATCH] Update documentation. --- docs/requirements.txt | 1 + docs/usage.rst | 8 ++++++-- pIceImarisConnector/pIceImarisConnector.py | 5 +---- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 2512274..33ca1c9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ numpy +sphinx sphinx_rtd_theme diff --git a/docs/usage.rst b/docs/usage.rst index afc5a26..a85ed79 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -40,6 +40,10 @@ In an Imaris XT file: From a python console: +.. note:: + + When starting Imaris, make sure to activate the ImarisXT:IPSS license! + .. code-block:: python # If Imaris is already running @@ -52,7 +56,7 @@ From a python console: Out[3]: pIceImarisConnector: connected to Imaris. In[4]: print(conn.mImarisApplication.GetVersion()) - Imaris x64 9.5.1 [Nov 27 2019] + Imaris x64 9.7.2 [Mar 24 2021] .. code-block:: python @@ -67,6 +71,6 @@ From a python console: # Remember to activate the ImarisXT license! In[4]: print(conn.mImarisApplication.GetVersion()) - Imaris x64 9.5.1 [Nov 27 2019] + Imaris x64 9.7.2 [Mar 24 2021] In[5]: conn.closeImaris(True) diff --git a/pIceImarisConnector/pIceImarisConnector.py b/pIceImarisConnector/pIceImarisConnector.py index 6e6e7b7..41ffc09 100644 --- a/pIceImarisConnector/pIceImarisConnector.py +++ b/pIceImarisConnector/pIceImarisConnector.py @@ -13,10 +13,7 @@ class pIceImarisConnector(object): - """pIceImarisConnector is a simple Python class that eases communication between Bitplane Imaris and Python - using the Imaris XT interface. - - *Copyright Aaron Ponti, 2013 - 2020.* + """pIceImarisConnector is a simple Python class that eases communication between Bitplane Imaris and Python using the Imaris XT interface. :param imarisApplication: (optional) if omitted, a pIceImarisConnector object is created that is not connected to any Imaris instance.