1*********************
2PyMOL Packaging Guide
3*********************
4
5===========================
6PyMOL environment variables
7===========================
8
9Typical installations don't require any environment variables to run
10PyMOL. PyMOL will automatically assign the following variables if they
11are unset:
12
13PYMOL_PATH = First of:
14  - <pymol python module> + "/pymol_path"
15  - parent of the "modules" directory if launch script matches
16    "modules/pymol/__init__.py"
17  - sys.prefix + "/share/pymol"
18PYMOL_DATA = $PYMOL_PATH/data
19PYMOL_SCRIPTS = $PYMOL_PATH/scripts
20
21=======================================================
22Suggested File Locations (for package managed installs)
23=======================================================
24
25== pymol package ==
26
27modules/pymol  -> /usr/lib/pythonX.X/site-packages/pymol
28modules/chempy -> /usr/lib/pythonX.X/site-packages/chempy
29modules/pmg_tk -> /usr/lib/pythonX.X/site-packages/pmg_tk
30
31== pymol-data package ==
32
33scripts     -> /usr/share/pymol/scripts (RUNTIME REQUIREMENT)
34data        -> /usr/share/pymol/data (RUNTIME REQUIREMENT)
35
36Installable with:
37python setup.py install --pymol-path=/usr/share/pymol
38