@@ -13,59 +13,59 @@ REQUIREMENTS
13
13
pyobjcryst requires Python 2.6 or 2.7, C++ compiler and the following
14
14
software:
15
15
16
- * ** libobjcryst ** - Object-Oriented Crystallographic Library for C++,
17
- https://github.com/diffpy/libobjcryst/
18
- * ** setuptools ** - tools for installing Python packages
19
- * ** python-dev ** - header files for interfacing Python with C
20
- * ** libboost-dev ** - Boost C++ libraries development files
16
+ * `` libobjcryst `` - Object-Oriented Crystallographic Library for C++,
17
+ https://github.com/diffpy/libobjcryst
18
+ * `` setuptools `` - tools for installing Python packages
19
+ * `` python-dev `` - header files for interfacing Python with C
20
+ * `` libboost-dev `` - Boost C++ libraries development files
21
21
22
22
With the exception of libobjcryst, the required software is commonly
23
23
available in system package manager, for example, on Ubuntu Linux the
24
24
required software can be installed as::
25
25
26
- sudo apt-get install \
27
- python-setuptools python-dev libboost-dev build-essential
26
+ sudo apt-get install \
27
+ python-setuptools python-dev libboost-dev build-essential
28
28
29
29
For Mac OS X machine with the MacPorts package manager the installation is::
30
30
31
- sudo port install \
32
- python27 py27-setuptools scons boost
31
+ sudo port install \
32
+ python27 py27-setuptools scons boost
33
33
34
34
When installing with MacPorts, make sure that MacPorts bin directory is the
35
35
first in the system PATH and python27 is selected as the default Python
36
36
version in MacPorts::
37
37
38
- sudo port select --set python python27
38
+ sudo port select --set python python27
39
39
40
40
41
41
INSTALLATION
42
42
------------
43
43
44
44
The easiest option is to use the latest DiffPy-CMI release bundle from
45
- http://www.diffpy.org/ , which comes with pyobjcryst and all other
45
+ http://www.diffpy.org, which comes with pyobjcryst and all other
46
46
dependencies included.
47
47
48
48
If you prefer to install from sources, you must first install the libobjcryst
49
49
library as per the instructions at
50
- https://github.com/diffpy/libobjcryst/ . Make sure other required
50
+ https://github.com/diffpy/libobjcryst. Make sure other required
51
51
software is in place as well and then run::
52
52
53
- sudo python setup.py install
53
+ sudo python setup.py install
54
54
55
55
This installs pyobjcryst for all users to the default system location.
56
56
If administrator (root) access is not available, see the usage info from
57
- `python setup.py install --help ` for options for installing to a user-writable
57
+ `` python setup.py install --help ` ` for options for installing to a user-writable
58
58
location. The installation integrity can be verified by changing to
59
59
the HOME directory and running::
60
60
61
- python -m pyobjcryst.tests.run
61
+ python -m pyobjcryst.tests.run
62
62
63
63
An alternative way of installing pyobjcryst is to use the SCons tool,
64
64
which can speed up the process by compiling C++ files in parallel (-j4)::
65
65
66
- sudo scons -j4 install
66
+ sudo scons -j4 install
67
67
68
- See `scons -h ` for description of build targets and options for
68
+ See `` scons -h ` ` for description of build targets and options for
69
69
choosing the installation directory.
70
70
71
71
@@ -81,26 +81,26 @@ Feel free to fork the project and contribute. To install pyobjcryst
81
81
in a development mode, where its sources are directly used by Python
82
82
rather than copied to a system directory, use::
83
83
84
- python setup.py develop --user
84
+ python setup.py develop --user
85
85
86
86
When developing it is preferable to compile the C++ files with
87
- SCons using the `build=develop ` option, which compiles the extension
87
+ SCons using the `` build=develop ` ` option, which compiles the extension
88
88
module with debug information and C-assertions checks::
89
89
90
- scons -j4 build=debug develop
90
+ scons -j4 build=debug develop
91
91
92
- The build script checks for a presence of `sconsvars.py ` file, which
93
- can be used to permanently set the `build ` variable. The SCons
94
- construction environment can be further customized in a `sconscript.local `
92
+ The build script checks for a presence of `` sconsvars.py ` ` file, which
93
+ can be used to permanently set the `` build ` ` variable. The SCons
94
+ construction environment can be further customized in a `` sconscript.local ` `
95
95
script. The package integrity can be verified by executing unit tests with
96
- `scons -j4 test `.
96
+ `` scons -j4 test ` `.
97
97
98
98
99
99
CONTACTS
100
100
--------
101
101
102
102
For more information on pyobjcryst please visit the project web-page
103
103
104
- http://www.diffpy.org/
104
+ http://www.diffpy.org
105
105
106
106
or email Prof. Simon Billinge at
[email protected] .
0 commit comments