Skip to content

Commit e2987ad

Browse files
authored
Update build instructions in README
Only mention setup.py based steps, pip build are serial and slow.
1 parent 17df35d commit e2987ad

File tree

1 file changed

+11
-18
lines changed

1 file changed

+11
-18
lines changed

README.md

+11-18
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,25 @@ It's thought that the Hubbard model approximates carbon nanostructures, such as
1313

1414
## C++
1515
- C++14 compiler (tested with recent versions of gcc and clang)
16-
- [Python 3](https://www.python.org/) version 3.7 or later, [numpy](http://www.numpy.org/)
16+
- [Python 3](https://www.python.org/) version 3.7 or later
1717
- [blaze](https://bitbucket.org/blaze-lib/blaze)
1818
- BLAS/LAPACK
1919

2020
## Python
2121
- [Pybind11](https://github.com/pybind/pybind11) >= 2.2.4
2222
- [numpy](http://www.numpy.org/)
2323
- [h5py](http://www.h5py.org/)
24-
- [scikit-learn](http://scikit-learn.org/stable/)
25-
- [matplotlib](https://matplotlib.org/)
24+
- [scikit-learn](http://scikit-learn.org/stable/) (optional)
25+
- [matplotlib](https://matplotlib.org/) (optional)
2626

2727
# Setup
2828

2929
## TL;DR
3030
See other sections for an explanation and details.
3131
```
3232
python3 setup.py configure --build-type=RELEASE --blaze=<path-to-blaze>
33-
pip3 install . [--user]
33+
python3 setup.py build -j <number-of-threads>
34+
python3 setup.py install
3435
```
3536

3637
## Configuring
@@ -50,33 +51,25 @@ with suitable arguments. The supported arguments are (run `python3 setup.py conf
5051

5152
This does not actually run CMake to configure the C++ build but merely performs some rudimentary checks and saves the parameters.
5253

53-
Note that specifying the compiler of build type when running `python3 setup.py build` does not work; they need to be set when configuring.
54+
Note that specifying the compiler or build type when running `python3 setup.py build` does not work; they need to be set when configuring.
5455

5556
## Building
5657
For **users**:
5758
Compile and install the package using
5859
```
59-
pip3 install . [--user]
60-
# or alternatively: python3 setup.py install [--user]
60+
python3 setup.py build -j <number-of-threads>
61+
python3 setup.py install [--user]
6162
```
6263

6364
For **developers**:
6465
Compile and install in development mode using
6566
```
66-
pip3 install -e . [--user]
67-
# or alternatively: python3 setup.py develop [--user]
67+
python3 setup.py develop [--user]
6868
```
6969
And just re-run the command after changing the code.
7070

71-
Unfortunately neither pip nor setup.py's install or develop commands support concurrent builds. So the first time you compile takes some time. If you installed in development mode, you can run
72-
```
73-
python3 setup.py build -j<n-threads>
74-
```
75-
to compile your changes in a parallel fashion.
76-
However, if you are in development mode, you must compile using one of the above commands before you can use the explicit build command!
77-
7871
## Testing
79-
Unit tests are automatically compiled when using the above commands (sorry for the extra compilation time, you are welcome to fix this :D).
72+
Unit tests are automatically compiled when using the above commands (sorry for the extra compilation time, we are working on a way around that).
8073
They only work however, if you are in development mode!
8174
You can run them via
8275
```
@@ -93,4 +86,4 @@ to generate the source code documentation using Doxygen. Then open `docs/html/in
9386

9487
Note that the `C++` interface is not identical to the `Python` interface. Documentation of the `Python` side is incomplete as of now.
9588

96-
There is additional documentation available under `docs/algorithm`; run `make` to generate it. This needs LaTeX to compiler PDFs.
89+
There is additional documentation available under `docs/algorithm`; run `make` to generate it. This needs LaTeX to compile PDFs.

0 commit comments

Comments
 (0)