Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
aarpon committed Dec 10, 2021
1 parent a084cb2 commit 1e2904b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
numpy
sphinx
sphinx_rtd_theme
8 changes: 6 additions & 2 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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)
5 changes: 1 addition & 4 deletions pIceImarisConnector/pIceImarisConnector.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 1e2904b

Please sign in to comment.