@@ -11,20 +11,21 @@ libdiffpy library requires C++ compiler and the following software:
11
11
12
12
Recommended software:
13
13
14
- * `libObjCryst ` - C++ library of free objects for crystallography, FIXME-URL
15
- * `cxxtest ` - CxxTest Unit Testing Framework, http://cxxtest.com/
14
+ * `libobjcryst ` - C++ library of free objects for crystallography,
15
+ https://github.com/diffpy/libobjcryst
16
+ * `cxxtest ` - CxxTest Unit Testing Framework, http://cxxtest.com
16
17
17
- Required software is usually available in the system package manager,
18
- for example, on Ubuntu Linux the dependencies can be installed as ::
18
+ On Ubuntu Linux the required software can be installed using the
19
+ system package manager ::
19
20
20
21
sudo apt-get install \
21
22
build-essential scons libboost-dev libgsl0-dev
22
23
23
- For Mac OS X machine with the MacPorts package manager one could do::
24
+ For Mac OS X machine with the MacPorts package manager the installation
25
+ command is::
24
26
25
27
sudo port install scons boost gsl
26
28
27
-
28
29
For other packages see their project pages for installation instructions.
29
30
30
31
@@ -42,12 +43,23 @@ This installs libdiffpy for all users under the `/usr/local` directory.
42
43
If administrator (root) access is not available, see the usage info from
43
44
`scons --help ` for options to install to a user-writable location.
44
45
46
+ To verify libdiffpy installation, compile and run the included
47
+ test code [examples/testlib.cpp](examples/testlib.cpp)::
45
48
46
- .. index :: Contribution
49
+ cd examples
50
+ c++ testlib.cpp -ldiffpy
51
+ ./a.out
52
+
53
+ If compilation fails because of missing header files or missing libdiffpy
54
+ library, adjust the `CPATH ` and `LIBRARY_PATH ` environment variables or
55
+ use the `-I ` or `-L ` compiler options. If the libdiffpy shared library
56
+ cannot be found at runtime, adjust the `LD_LIBRARY_PATH ` environment variable.
47
57
48
- Contribution
49
- ------------------------------------------------------------------------
50
58
59
+ .. index :: Development
60
+
61
+ Development
62
+ ------------------------------------------------------------------------
51
63
52
64
libdiffpy is an open-source software developed as a part of the
53
65
DiffPy-CMI complex modeling initiative at the Brookhaven National
@@ -64,4 +76,5 @@ The build script checks for a presence of `sconsvars.py` file, which
64
76
can be used to permanently set the `build ` variable. The SCons
65
77
construction environment can be further customized in a `sconscript.local `
66
78
script. The library integrity can be verified by executing unit tests with
67
- `scons -j4 test ` (requires the CxxTest framework).
79
+ `scons -j4 test ` (requires the CxxTest framework).
80
+
0 commit comments