Skip to content

Commit 8fc6a9e

Browse files
author
Kevin D Smith
committed
Doc updates for installation
1 parent 239d28d commit 8fc6a9e

File tree

3 files changed

+43
-10
lines changed

3 files changed

+43
-10
lines changed

README.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ Requirements
2929

3030
To access the CAS binary protocol (recommended), you need the following:
3131

32-
1. **64-bit** Python 2.7+/3.4+ on Linux (see shared library notes below)
33-
2. Pandas 0.16.0+
32+
* **64-bit** Python 2.7, 3.4, or 3.5 on Linux (see shared library notes below)
3433

3534
The binary protocol requires pre-compiled components found in the
3635
``pip`` installer only. These pieces are not available as source code and
@@ -40,7 +39,7 @@ amounts of data. It also offers more advanced data loading from the client
4039
and data formatting features.
4140

4241
To access the CAS REST interface only, you can use the pure Python code
43-
which runs in Python 2.7+/3.4+. While not as fast as the binary protocol,
42+
which runs in Python 2.7/3.4+. While not as fast as the binary protocol,
4443
the pure Python interface is more portable.
4544

4645
Linux Library Dependencies
@@ -52,6 +51,14 @@ make binary protocol connections to CAS. If you do not have this library on
5251
your machine you can install the ``numactl`` package for your distribution
5352
to make it available to SWAT.
5453

54+
Python Dependencies
55+
===================
56+
57+
The SWAT package uses many features of the Pandas Python package and other
58+
dependencies of Pandas. If you do not already have version 0.16.0 or greater
59+
of Pandas installed, ``pip`` will install or update it for you when you
60+
install SWAT.
61+
5562

5663
Installation
5764
------------

doc/source/install.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,10 @@
44
Installation
55
============
66

7-
The SWAT package can be installed using either ``pip`` or just by running
8-
``python setup.py install`` in the expanded tar.gz file. Before installing,
9-
you should make sure that you have fulfilled the following requirements.
10-
These requirements are for the CAS binary protocol (recommended).
7+
The SWAT package is installed using the ``pip`` command. The requirements
8+
for using the binary protocol of CAS (recommended) are as follows.
119

12-
* **64-bit** Python 2.7+/3.4+ on Linux (see shared library notes below)
13-
* Pandas 0.16.0+
10+
* **64-bit** Python 2.7, 3.4, or 3.5 on Linux (see shared library notes below)
1411

1512
The binary protocol requires pre-compiled components found in the ``pip``
1613
installer only. These pieces are not available as source code and
@@ -20,7 +17,7 @@ amounts of data. It also offers more advanced data loading from the client
2017
and data formatting features.
2118

2219
To access the CAS REST interface only, you can use the pure Python code which
23-
runs in Python 2.7+/3.4+. You will still need Pandas installed. While not as
20+
runs in Python 2.7/3.4+. You will still need Pandas installed. While not as
2421
fast as the binary protocol, the pure Python interface is more portable.
2522
For more information, see :ref:`Binary vs. REST <binaryvsrest>`.
2623

@@ -43,6 +40,15 @@ your machine you can install the ``numactl`` package for your distribution
4340
to make it available to SWAT.
4441

4542

43+
Python Dependencies
44+
-------------------
45+
46+
The SWAT package uses many features of the Pandas Python package and other
47+
dependencies of Pandas. If you do not already have version 0.16.0 or greater
48+
of Pandas installed, ``pip`` will install or update it for you when you
49+
install SWAT.
50+
51+
4652
Pip
4753
---
4854

doc/source/troubleshooting.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,26 @@ Just as with any authenticated network service, you may run into problems
99
from time to time while connecting to CAS. These are some of the more
1010
common problems you may run across.
1111

12+
Missing Linux Library Dependencies
13+
==================================
14+
15+
SWAT uses various shared libraries commonly available on Linux machines.
16+
If you are missing a shared library that SWAT requires, you may see a message
17+
such as the following when creating a CAS connection.
18+
19+
.. code-block:: python
20+
21+
In [1]: conn = swat.CAS(hostname, port)
22+
tkBoot failed: Cannot dlopen [tkmk.so] : [libnuma.so.1: cannot open shared object file: No such file or directory]
23+
24+
This particular error can be solved by installing the ``numactl`` package of
25+
your Linux distribution. If you do not have system administrator privileges,
26+
you can set an environment variable ``LD_LIBRARY_PATH`` to the location of
27+
a copy of ``libnuma.so.1``. However, it is recommended that you contact your system
28+
administrator to install this library so that it will receive regular updates
29+
with the system.
30+
31+
1232
Incorrect SAS TK Configuration
1333
==============================
1434

0 commit comments

Comments
 (0)