| 1 |
Note: This file describes the installation of source release of BKChem. If you have |
| 2 |
downloaded the binary release, please read the INSTALL.binary file instead. |
| 3 |
|
| 4 |
|
| 5 |
|
| 6 |
Installation of BKChem is very simple. But before you can run the program you |
| 7 |
must install the following: |
| 8 |
|
| 9 |
1/ Python. |
| 10 |
On www.python.org get a distribution of Python for your platform. Note that |
| 11 |
BKChem will run only on Python 2.6 or newer. |
| 12 |
2/ pycairo |
| 13 |
This library is optional and is available only for Linux. It enables high quality |
| 14 |
export to PDF and PNG formats with support for antialiased unicode texts. |
| 15 |
It requires the cairo library. Both can be found on http://cairographics.org/snapshots/. |
| 16 |
The current and tested version is 0.5.1. |
| 17 |
|
| 18 |
|
| 19 |
|
| 20 |
--- Single directory deployment --- |
| 21 |
|
| 22 |
No installation is needed to run BKChem. This means that you can run the program |
| 23 |
directly after unpacking the downloaded sources. |
| 24 |
Simply run the bkchem.py located in the 'bkchem-X.Y.Z/bkchem' directory, where X,Y,Z |
| 25 |
are version numbers of BKChem release. |
| 26 |
|
| 27 |
|
| 28 |
example: |
| 29 |
on Unix do |
| 30 |
>cd "the dir where you have downloaded the BKChem package" |
| 31 |
>tar -xzf bkchem-X.X.X.tgz -C "the dir where you want to unpack BKChem" |
| 32 |
>cd "the dir where you have unpacked BKChem"/bkchem-X.Y.Z/bkchem |
| 33 |
>python bkchem.py |
| 34 |
|
| 35 |
|
| 36 |
|
| 37 |
--- System-wide install --- |
| 38 |
|
| 39 |
Under Linux and other Unix systems you have the possibility to use a 'classic' |
| 40 |
way of installing software. Major advantage of doing this is that it you will have |
| 41 |
a "bkchem" program in your path, thus easily startable from any path. |
| 42 |
For the purpose of installation BKChem uses a standard for installation of |
| 43 |
python modules - distutils. The installation is accomplished by simply running |
| 44 |
the setup.py script from the bkchem directory with 'install' argument: |
| 45 |
|
| 46 |
>python setup.py install |
| 47 |
|
| 48 |
NOTE: usually you have to be root in order to be able to perform the install! |
| 49 |
|
| 50 |
This way all python sources will be installed in a standard directory for |
| 51 |
third-party modules - usually something like '/usr/lib/python/site-packages'. |
| 52 |
The templates, pixmaps and other such stuff will go into 'prefix/share/bkchem', |
| 53 |
where prefix is usually 'usr' or 'usr/local'. |
| 54 |
Documentation will be put in 'prefix/share/doc/bkchem'. |
| 55 |
Finally a sh-script 'prefix/bin/bkchem' will be created so that you can run |
| 56 |
bkchem from anywhere you want. |
| 57 |
|
| 58 |
To influence the paths that are used during install - especially the 'prefix' |
| 59 |
run: |
| 60 |
|
| 61 |
>python setup.py install --help |
| 62 |
|
| 63 |
to see the available options. |
| 64 |
|
| 65 |
Running |
| 66 |
|
| 67 |
>python setup.py --help |
| 68 |
|
| 69 |
will give you another set of options available for the install. |
| 70 |
|
| 71 |
|
| 72 |
Any comments or reports on installation process are especially welcome as this |
| 73 |
is very hard to test thoroughly on a single machine. |