NAME
notes_python - Python within Antelope
DESCRIPTION
The python interpreter included with
Antelope is version 3.6.5. We have compiled it to reside in an
/opt/antelope subdirectory,
and have pre-loaded the extension modules listed below, however other than that it is just a stock Python interpreter (
http://www.python.org ).
The Antelope python interpreter is available via the path
$ANTELOPE/bin/python
An interactive version is also available, at
$ANTELOPE/bin/ipython
The most convenient way to interact with Antelope-enabled python is probably via the
ipa(1) script, which launches
ipython with
a profile designed for Antelope.
Extension Modules
The following additional
Python modules are included in the
Antelope Python interpreter:
-
dnspython
Domain Name Resolution tools
-
docutils
Documentation tools included to support Sphinx
-
ipython
The ipython program is an interactive shell interpreter for Python ( http://ipython.org )
-
jinja2
Templating engine included to support Sphinx.
-
matplotlib
The matplotlib module contains 2D plotting utilities that mimic Matlab graphical output. Further information
is available from http://matplotlib.sourceforge.net .
-
mock
This is a Python testing utility that allows you to replace parts of your system under test with mock objects
-
nose2
This is another Python testing utility
-
numpy
The numpy module is a set of scientific computing tools from http://numpy.scipy.org . The matplotlib module requires numpy.
-
pil
The Python Imaging Library ( http://www.pythonware.com/products/pil/ ) provides image processing capabilities for Python.
-
pmw
The Python Mega Widgets are extended graphical tools for Python Tk
-
psutil
The Python System and Process Utilities retrieve information on running processes and system utilization (CPU, memory, disks, network).
-
pygments
Syntax highlighting package included to support Sphinx.
-
pyparsing
This module creates and executes simple grammars; installed to support matplotlib.
-
python-dateutil
This module provides extensions to the standard datetime module. Installed to support matplotlib.
-
setuptools
The setuptools module includes useful tools for extending Python, such as the easy_install program, which allows users to install other well-formed
Python modules downloaded from the internet. For further information on using easy_install to install properly formed
Python extensions, see http://pypi.python.org/pypi/setuptools and http://peak.telecommunity.com/DevCenter/EasyInstall .
-
six
This is a Python 2 to 3 compatibility library.
-
sphinx
This is a utility for formatting documentation.
-
tornado
This is a web framework and asynchronous network processing facility, installed to support matplotlib
-
twisted
The twisted module is an event-driven networking engine from http://wwww.twistedmatrix.com . The twisted module is the
basis of the Peregrine rtwebserver(1) program.
-
xlrd
Utilities to read Excel spreadsheets
-
xlwt
Utilities to write Excel spreadsheets
-
zope
The zope module provides a web application server. The twisted web applications required zope.interface.
License files for Python and the included Python modules are contained in the directory
/opt/antelope/python3.6.5/licenses/
Python Interface to Antelope
An overview of the
Python interface to
Antelope is presented in
antelope_python(3y).
obspy
The
obspy packages,
http://www.obspy.org , were not written by BRTT and are therefore not shipped with
Antelope. At the time of writing
obspy
appears to support
easy_install, however. Therefore, to install the core
obspy package into the
Antelope Python interpreter, for example,
one should be able to execute
% easy_install obspy.core
SEE ALSO
antelope(1), antelope_python(3y), ipa(1)
BUGS AND CAVEATS
On Mac systems the
ipython program may complain that
libedit has been detected and warning of problems with
readline. This has
not been corrected for shipment with Antelope due to licensing restrictions on the GNU
readline module. However, if you would like to install the
readline module yourself to suppress these warnings and problems, the command to do so would be:
% easy_install readline
AUTHOR
Kent Lindquist