Skip to content

Commit fb05d4d

Browse files
authored
Add note on LD_LIBRARY_PATH to install instructions for Conda (#1140)
1 parent d9f3786 commit fb05d4d

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

docs/tutorials/installation.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,18 @@
22

33
By following the instructions below, you are installing the `synapseclient`, `synapseutils` and the command line client.
44

5-
## PyPI
5+
## TL;DR For Experts
6+
1. Set up your Python development environment in your preferred manner (e.g. with `conda`, `pyenv`, etc).
7+
2. Run
8+
```
9+
pip install --upgrade synapseclient
10+
```
11+
3. Verify your installation
12+
```
13+
pip show synapseclient
14+
```
15+
16+
## Installation Guide For: PyPI Users
617

718
The [synapseclient](https://pypi.python.org/pypi/synapseclient/) package is available from PyPI. It can be installed or upgraded with pip. Due to the nature of Python, we highly recommend you set up your python environment with [conda](https://www.anaconda.com/products/distribution) or [pyenv](https://github.com/pyenv/pyenv) and create virtual environments to control your Python dependencies for your work.
819

@@ -20,6 +31,14 @@ pip install --upgrade "synapseclient[pandas]"
2031
pip install --upgrade "synapseclient[pandas, pysftp, boto3]"
2132
```
2233

34+
> **NOTE** <br>
35+
> The `synapseclient` package may require loading shared libraries located in your system's `/usr/local/lib` directory. Some users working
36+
with `conda` have experienced issues with shared libraries not being found due to the system searching in the wrong locations. Although
37+
not recommended, one solution for this is manually configuring the `LD_LIBRARY_PATH` environment variable to point
38+
to the `/usr/local/lib` directory. [See here](https://github.com/conda/conda/issues/12800) for more context on this solution, and for alternatives.
39+
40+
----
41+
2342
- pyenv: Use [virtualenv](https://virtualenv.pypa.io/en/latest/) to manage your python environment:
2443

2544
```bash
@@ -42,7 +61,7 @@ python3 -m pip3 install --upgrade "synapseclient[pandas, pysftp, boto3]"
4261

4362
The dependencies on pandas, pysftp, and boto3 are optional. The Synapse `synapseclient.table` feature integrates with Pandas. Support for sftp is required for users of SFTP file storage. Both require native libraries to be compiled or installed separately from prebuilt binaries.
4463

45-
## Local
64+
## Installation Guide For: Git Users
4665

4766
Source code and development versions are [available on Github](https://github.com/Sage-Bionetworks/synapsePythonClient). Installing from source:
4867

0 commit comments

Comments
 (0)