File: PACKAGING

package info (click to toggle)
pymol 1.7.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 42,668 kB
  • ctags: 25,775
  • sloc: ansic: 494,779; python: 75,446; cpp: 20,088; makefile: 351; sh: 172; csh: 21
file content (74 lines) | stat: -rw-r--r-- 2,356 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
*********************
PyMOL Packaging Guide
*********************

===========================
PyMOL environment variables
===========================

PyMOL is designed to run under two types of environments.  They are:

(1) Single-directory self-contained install. (Windows, Mac, Unix Standalone)

(2) Package-managed with files spread all over the OS. (RedHat, Debian)

Environment (1)
---------------

Environment variable PYMOL_PATH serves as the root directory
and tells PyMOL where to find everything, including its code.

Required: PYMOL_PATH

Environment (2)
---------------

PyMOL code is installed in the system Python namespace, so no explicit
environment variable is required to access it.  The root python
modules defined in site-packages are "pymol", "pmg_tk", and "chempy".

Required: PYMOL_DATA, PYMOL_SCRIPTS

PYMOL_DATA is usually /usr/share/pymol/data
PYMOL_SCRIPTS is usually /usr/share/pymol/scripts

Mechanism
---------

PYMOL_DATA and PYMOL_SCRIPTS dominate if provided.  Otherwise, if
PYMOL_PATH is defined, PYMOL_DATA becomes $PYMOL_PATH/data, and
PYMOL_SCRIPTS becomes $PYMOL_PATH/scripts. 

if $PYMOL_PATH is defined and $PYMOL_PATH/modules exists, then
$PYMOL_PATH/modules is added to the Python module search path.

Under MacOS X, PYMOL_PATH is self-defining.  Under Windows, this
environment variable is stored in the registry during installation.
Under Unix, PYMOL_PATH needs to be defined prior to startup, usually
by "pymol.com".

=======================================================
Suggested File Locations (for package managed installs)
=======================================================

== pymol package ==

modules/pymol  -> /usr/lib/pythonX.X/site-packages/pymol
modules/chempy -> /usr/lib/pythonX.X/site-packages/chempy
modules/pmg_tk -> /usr/lib/pythonX.X/site-packages/pmg_tk

scripts     -> /usr/share/pymol/scripts (RUNTIME REQUIREMENT)
data        -> /usr/share/pymol/data (RUNTIME REQUIREMENT)

examples    -> /usr/share/doc/pymol/examples
doc         -> /usr/share/doc/pymol/doc
LICENSE     -> /usr/share/doc/pymol/LICENSE
CHANGES     -> /usr/share/doc/pymol/CHANGES
README      -> /usr/share/doc/pymol/README

== pymol-devel package ==

test        -> /usr/share/pymol/test (TESTING RUNTIME REQUIREMENT)

DEVELOPERS  -> /usr/share/doc/pymol/DEVELOPERS
PACKAGING   -> /usr/share/doc/pymol/PACKAGING