| 1 |
------------------------------------------- |
| 2 |
Building and installing the C/C++ library |
| 3 |
|
| 4 |
Requirements: |
| 5 |
A C++17 compiler |
| 6 |
Make (GNU make is OK) |
| 7 |
|
| 8 |
|
| 9 |
Next, execute the following commands: |
| 10 |
|
| 11 |
cd src/IsoSpec++ |
| 12 |
make |
| 13 |
|
| 14 |
You may copy the resulting .so file to a convenient location. |
| 15 |
If you wish to develop software using this library, you will also |
| 16 |
have to place the header files (*.hpp/*.h) somewhere your C/C++ |
| 17 |
compiler can find them. |
| 18 |
|
| 19 |
------------------------------------------ |
| 20 |
Building and installing the Python package |
| 21 |
|
| 22 |
IMPORTANT: please note that the Python package is standalone, in the |
| 23 |
sense that it does not need the C/C++ library to be installed separately. |
| 24 |
|
| 25 |
IsoSpecPy is compatible with both CPython and PyPy, running on Unix, |
| 26 |
Cygwin or in MinGW environment. |
| 27 |
|
| 28 |
The preferred method of installation is by using the pip package manager. |
| 29 |
In order to do that, simply issue the following command, replacing |
| 30 |
"<python>" with your Python executable (python/python3/pypy/...) |
| 31 |
|
| 32 |
<python> -m pip install IsoSpecPy |
| 33 |
|
| 34 |
If, instead, you wish to install the package manually, follow these |
| 35 |
instructions: |
| 36 |
|
| 37 |
Requirements: |
| 38 |
Python (obviously) |
| 39 |
C++17 compiler |
| 40 |
|
| 41 |
Execute the following commands: |
| 42 |
pip install . |
| 43 |
|
| 44 |
------------------------------------------ |
| 45 |
Building and installing the R package |
| 46 |
|
| 47 |
The preferred installation method is to use the CRAN package installer. |
| 48 |
To do that, simply issue the command: |
| 49 |
|
| 50 |
install.packages('IsoSpecR') |
| 51 |
|
| 52 |
in your R session. However it is possible to install the package manually, |
| 53 |
from source, by following these instructions: |
| 54 |
|
| 55 |
Requirements: |
| 56 |
R (>= 3.2.1) |
| 57 |
Rcpp package from CRAN |
| 58 |
C++11 compiler, clang++ (v3.3 or later) or g++ (v4.7 or later) |
| 59 |
|
| 60 |
Move to the folder containing the IsoSpecR folder. Then run in terminal: |
| 61 |
|
| 62 |
cd src |
| 63 |
R CMD build IsoSpecR |
| 64 |
R CMD INSTALL IsoSpecR_*.tar.gz |
| 65 |
|
| 66 |
All necessary packages should download automatically. |
| 67 |
|