Skip to content
This repository was archived by the owner on Feb 2, 2024. It is now read-only.

Commit 8428af5

Browse files
Vyacheslav-SmirnovVyacheslav-Smirnov
authored
Add conda/whee linstall steps; update build instructions (#750)
* Add install instructions for sdc codna and wheel packages * Update build instructions; correct doc copyright
1 parent a65ff58 commit 8428af5

File tree

3 files changed

+50
-36
lines changed

3 files changed

+50
-36
lines changed

‎README.rst‎

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,24 @@ the code by leveraging modern hardware instructions and by utilizing all availab
1919

2020
Intel SDC's documentation can be found `here <https://intelpython.github.io/sdc-doc/>`_.
2121

22-
Installing Binary Packages (conda)
22+
Installing Binary Packages (conda and wheel)
2323
----------------------------------
24+
Intel SDC is available on the Anaconda Cloud intel/label/beta channel.
25+
Distribution includes Intel SDC for Python 3.6 and Python 3.7 for Windows and Linux platforms.
26+
27+
Intel SDC conda package can be installed using the steps below:
2428
::
2529

26-
Currently binary packages are not provided.
30+
> conda create -n sdc_env python=<3.7 or 3.6>
31+
> conda activate sdc_env
32+
> conda install sdc -c intel/label/beta -c intel -c defaults -c conda-forge --override-channels
33+
34+
Intel SDC wheel package can be installed using the steps below:
35+
::
36+
37+
> conda create -n sdc_env python=<3.7 or 3.6> pip
38+
> conda activate sdc_env
39+
> pip install --index-url https://pypi.anaconda.org/intel/label/beta/simple --extra-index-url https://pypi.anaconda.org/intel/simple --extra-index-url https://pypi.org/simple sdc
2740

2841

2942
Building Intel® SDC from Source on Linux
@@ -39,8 +52,8 @@ If you do not have conda, we recommend using Miniconda3::
3952
./miniconda.sh -b
4053
export PATH=$HOME/miniconda3/bin:$PATH
4154

42-
Intel SDC uses Numba ``0.48.0`` tag (referred later as ``numba_commit``) from master branch for build and run.
43-
That is why it is required to build specified Numba first. Build steps are described below.
55+
Intel SDC uses special Numba build based on ``0.48.0`` tag for build and run.
56+
Required Numba version can be installed from ``intel/label/beta`` channel from the Anaconda Cloud.
4457

4558
It is possible to build Intel SDC via conda-build or setuptools. Follow one of the
4659
cases below to install Intel SDC and its dependencies on Linux.
@@ -55,26 +68,16 @@ Building on Linux with conda-build
5568
source activate CBLD
5669
git clone https://github.com/IntelPython/sdc.git
5770
cd sdc
58-
# Build Numba
59-
conda build --python $PYVER --numpy $NUMPYVER --output-folder <path_to_sdc>/numba_build -c numba -c defaults -c intel --override-channels buildscripts/numba-conda-recipe/recipe
60-
# Build Intel SDC
61-
conda build --python $PYVER --numpy $NUMPYVER -c file://<path_to_sdc>/numba_build -c numba -c defaults -c conda-forge --override-channels buildscripts/sdc-conda-recipe
71+
conda build --python $PYVER --numpy $NUMPYVER --output-folder=<output_folder> -c intel/label/beta -c defaults -c intel -c conda-forge --override-channels buildscripts/sdc-conda-recipe
6272

6373
Building on Linux with setuptools
6474
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6575
::
6676

6777
PYVER=<3.6 or 3.7>
6878
NUMPYVER=<1.16 or 1.17>
69-
conda create -n SDC -q -y -c numba -c defaults -c intel -c conda-forge python=$PYVER numpy=$NUMPYVER pandas=0.25.3 scipy pyarrow=0.15.1 gcc_linux-64 gxx_linux-64 tbb-devel llvmlite=0.31.0
79+
conda create -n SDC -q -y -c intel/label/beta -c defaults -c intel -c conda-forge python=$PYVER numpy=$NUMPYVER numba=0.48.0 pandas=0.25.3 scipy pyarrow=0.15.1 gcc_linux-64 gxx_linux-64
7080
source activate SDC
71-
# Build Numba
72-
git clone https://github.com/numba/numba.git
73-
cd numba
74-
git checkout numba_commit
75-
python setup.py install
76-
# build SDC
77-
cd ..
7881
git clone https://github.com/IntelPython/sdc.git
7982
cd sdc
8083
python setup.py install
@@ -103,28 +106,18 @@ Building on Windows with conda-build
103106
conda activate CBLD
104107
git clone https://github.com/IntelPython/sdc.git
105108
cd sdc
106-
# Build Numba
107-
conda build --python %PYVER% --numpy %NUMPYVER% --output-folder <path_to_sdc>\numba_build -c numba -c defaults -c intel --override-channels buildscripts\numba-conda-recipe\recipe
108-
# Build Intel SDC
109-
conda build --python %PYVER% --numpy %NUMPYVER% -c <path_to_sdc>\numba_build -c numba -c defaults -c conda-forge --override-channels buildscripts\sdc-conda-recipe
109+
conda build --python %PYVER% --numpy %NUMPYVER% --output-folder=<output_folder> -c intel/label/beta -c defaults -c intel -c conda-forge --override-channels buildscripts\sdc-conda-recipe
110110

111111
Building on Windows with setuptools
112112
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113113
::
114114

115115
set PYVER=<3.6 or 3.7>
116116
set NUMPYVER=<1.16 or 1.17>
117-
conda create -n SDC -c numba -c defaults -c intel -c conda-forge python=%PYVER% numpy=%NUMPYVER% pandas=0.25.3 scipy pyarrow=0.15.1 tbb-devel llvmlite=0.31.0
117+
conda create -n SDC -c intel/label/beta -c defaults -c intel -c conda-forge python=%PYVER% numpy=%NUMPYVER% numba=0.48.0 pandas=0.25.3 scipy pyarrow=0.15.1
118118
conda activate SDC
119119
set INCLUDE=%INCLUDE%;%CONDA_PREFIX%\Library\include
120120
set LIB=%LIB%;%CONDA_PREFIX%\Library\lib
121-
# Build Numba
122-
git clone https://github.com/numba/numba.git
123-
cd numba
124-
git checkout numba_commit
125-
python setup.py install
126-
# Build Intel SDC
127-
cd ..
128121
git clone https://github.com/IntelPython/sdc.git
129122
cd sdc
130123
python setup.py install
@@ -147,6 +140,12 @@ Building documentation
147140
----------------------
148141
Building Intel SDC User's Guide documentation requires pre-installed Intel SDC package along with compatible Pandas* version as well as Sphinx* 2.2.1 or later.
149142

143+
Intel SDC documentation includes Intel SDC examples output which is pasted to functions description in the API Reference.
144+
In order to get the correct examples result it is required to install ``scipy`` package before documentation build:
145+
::
146+
147+
conda install scipy -c intel --override-channels
148+
150149
Use ``pip`` to install Sphinx* and extensions:
151150
::
152151

‎docs/source/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676
# -- Project information -----------------------------------------------------
7777

7878
project = 'Intel® Scalable Dataframe Compiler'
79-
copyright = '2019, Intel Corporation'
79+
copyright = '2019-2020, Intel Corporation'
8080
author = 'Intel Corporation'
8181

8282
# The full version, including alpha/beta/rc tags

‎docs/source/getting_started.rst‎

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,27 @@ Installation
3535
#############
3636
You can use conda and pip package managers to install Intel® SDC into your Python* environment.
3737

38-
.. todo::
39-
Provide installation instructions for public packages on Anaconda.org and PyPI
38+
Intel SDC is available on the Anaconda Cloud intel/label/beta channel.
39+
Distribution includes Intel SDC for Python 3.6 and 3.7 for Windows and Linux platforms.
40+
41+
Intel SDC conda package can be installed using the steps below:
42+
::
43+
44+
> conda create -n sdc_env python=<3.7 or 3.6>
45+
> conda activate sdc_env
46+
> conda install sdc -c intel/label/beta -c intel -c defaults -c conda-forge --override-channels
47+
48+
Intel SDC wheel package can be installed using the steps below:
49+
::
4050

41-
Experienced users can also buildIntel SDC from sources
42-
`for Linux*<https://github.com/IntelPython/sdc#building-intel-sdc-from-source-on-linux>`_ and
43-
`for Windows*<https://github.com/IntelPython/sdc#building-intel-sdc-from-source-on-windows>`_.
51+
> conda create -n sdc_env python=<3.7 or 3.6> pip
52+
> conda activate sdc_env
53+
> pip install --index-url https://pypi.anaconda.org/intel/label/beta/simple --extra-index-url https://pypi.anaconda.org/intel/simple --extra-index-url https://pypi.org/simple sdc
54+
55+
56+
Experienced users can also build Intel SDC from sources
57+
`for Linux* <https://github.com/IntelPython/sdc#building-intel-sdc-from-source-on-linux>`_ and
58+
`for Windows* <https://github.com/IntelPython/sdc#building-intel-sdc-from-source-on-windows>`_.
4459

4560
Basic Usage
4661
###########
@@ -81,5 +96,5 @@ What If I Get Poor Performance?
8196
Build Instructions
8297
##################
8398

84-
.. todo::
85-
Provide step-by-step build instructions for Linux*, Windows*, and Mac*.
99+
Build instructions for Linux*: https://github.com/IntelPython/sdc#building-intel-sdc-from-source-on-linux
100+
Build instructions for Windows*: https://github.com/IntelPython/sdc#building-intel-sdc-from-source-on-windows

0 commit comments

Comments
 (0)