Skip to content

Commit b2dc639

Browse files
committed
Update the INSTALL instructions
1 parent 591a262 commit b2dc639

File tree

1 file changed

+13
-33
lines changed

1 file changed

+13
-33
lines changed

INSTALL

Lines changed: 13 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,20 @@
22
Building and installing the C/C++ library
33

44
Requirements:
5-
A C++11 compiler, clang++ (v3.3 or later) or g++ (v4.7 or later)
5+
A C++17 compiler
66
Make (GNU make is OK)
77

88

9-
Note: clang++ is the default (and preferred) compiler as it produces
10-
faster code (in our tests, the difference in speed is about 20%).
11-
If you'd like to use g++ instead, please edit the first line of
12-
IsoSpec++/Makefile appropriately.
13-
149
Next, execute the following commands:
1510

16-
cd IsoSpec++
11+
cd src/IsoSpec++
1712
make
1813

1914
You may copy the resulting .so file to a convenient location.
20-
If you wish to develop software using this library, you will also
15+
If you wish to develop software using this library, you will also
2116
have to place the header files (*.hpp/*.h) somewhere your C/C++
2217
compiler can find them.
2318

24-
On Windows, you should turn on the MANN_LIBRARY pre-processor directive when
25-
building the library.
26-
2719
------------------------------------------
2820
Building and installing the Python package
2921

@@ -34,37 +26,24 @@ IsoSpecPy is compatible with both CPython and PyPy, running on Unix,
3426
Cygwin or in MinGW environment.
3527

3628
The preferred method of installation is by using the pip package manager.
37-
In order to do that, simply issue the following command, replacing
29+
In order to do that, simply issue the following command, replacing
3830
"<python>" with your Python executable (python/python3/pypy/...)
3931

4032
<python> -m pip install IsoSpecPy
4133

42-
If, instead, you wish to install the package manually, follow these
34+
If, instead, you wish to install the package manually, follow these
4335
instructions:
4436

4537
Requirements:
46-
Python (obviously) (v2 and v3 are supported)
47-
C++11 compiler, clang++ (v3.3 or later) or g++ (v4.7 or later)
48-
setuptools
49-
cffi (this, if not present, will be automatically downloaded and
50-
installed by the setup script, however you may prefer to use
51-
your distribution's package manager to install that)
38+
Python (obviously)
39+
C++17 compiler
5240

5341
Execute the following commands:
54-
cd IsoSpecPy
55-
sudo python setup.py install
56-
57-
Again, clang++ is the preferred compiler and will be used if found by the
58-
setup script. If you want to override the behaviour (if you have clang++
59-
installed, but still want to use g++) you will have to replace the last
60-
command with:
61-
62-
ISO_USE_DEFAULT_CXX=TRUE sudo python setup.py install
63-
42+
pip install .
6443

6544
------------------------------------------
6645
Building and installing the R package
67-
46+
6847
The preferred installation method is to use the CRAN package installer.
6948
To do that, simply issue the command:
7049

@@ -80,8 +59,9 @@ Requirements:
8059

8160
Move to the folder containing the IsoSpecR folder. Then run in terminal:
8261

83-
R CMD build IsoSpecR
84-
R CMD INSTALL IsoSpecR_*.tar.gz
62+
cd src
63+
R CMD build IsoSpecR
64+
R CMD INSTALL IsoSpecR_*.tar.gz
8565

86-
All necessary packages should download automatically.
66+
All necessary packages should download automatically.
8767

0 commit comments

Comments
 (0)