[doc] Improve the developer installation documentation #1388

archibate · 2020-07-03T14:48:00Z

Related issue = repeat #1343

Co-authored-by: Yuanming Hu <yuanming-hu@users.noreply.github.com>

rexwangcc

Thanks for updating the docs! I left some comments but LGTM in general!

rexwangcc · 2020-07-04T19:46:30Z

docs/dev_install.rst

@@ -19,18 +19,22 @@ Installing Dependencies

  .. code-block:: bash

-    python3 -m pip install --user setuptools astpretty astor pybind11 Pillow dill
+    python3 -m pip install --user setuptools wheel astor pybind11 Pillow dill


Just for a sanity check, so we don't need astpretty anymore?

Yes, I uninstalled astpretty and found everything working well, but wheel is necessary but not included here.

docs/dev_install.rst

rexwangcc · 2020-07-04T20:23:12Z

docs/dev_install.rst

    Make sure you add the ``bin`` folder containing ``clang.exe`` to the ``PATH`` environment variable.

  * On OS X: you don't need to do anything.

-  * On Ubuntu, execute ``sudo apt install libtinfo-dev clang-8``.
+  * On Ubuntu, execute ``sudo apt install clang-8``.


I thought libtinfo-dev is still needed on Ubuntu?

We may move it to another section, this section is for clang, also other Linux dist do need this stupid lib too. In fact, I found my dev install don't need this at all... @yuanming-hu Is our Linux buildbot running on Ubuntu-16.04 that caused this issue? ldd shows that my dev build use libncursesw.so.6 instead of libtinfo.so.5.

130 root@archlinux ~/taichi (git)-[ti-init-toggle-advanced-optimization] # ldd build/libtaichi_core.so :( linux-vdso.so.1 (0x00007ffec11ec000) libpthread.so.0 => /usr/lib/libpthread.so.0 (0x00007fea2b633000) libstdc++.so.6 => /usr/lib/libstdc++.so.6 (0x00007fea2b456000) libX11.so.6 => /usr/lib/libX11.so.6 (0x00007fea2b315000) librt.so.1 => /usr/lib/librt.so.1 (0x00007fea2b30a000) libm.so.6 => /usr/lib/libm.so.6 (0x00007fea2b1c5000) libz.so.1 => /usr/lib/libz.so.1 (0x00007fea2b1ab000) libdl.so.2 => /usr/lib/libdl.so.2 (0x00007fea2b1a3000) libncursesw.so.6 => /usr/lib/libncursesw.so.6 (0x00007fea2b132000) libc.so.6 => /usr/lib/libc.so.6 (0x00007fea2af6b000) /usr/lib64/ld-linux-x86-64.so.2 (0x00007fea2efae000) libgcc_s.so.1 => /usr/lib/libgcc_s.so.1 (0x00007fea2af51000) libxcb.so.1 => /usr/lib/libxcb.so.1 (0x00007fea2af27000) libXau.so.6 => /usr/lib/libXau.so.6 (0x00007fea2af22000) libXdmcp.so.6 => /usr/lib/libXdmcp.so.6 (0x00007fea2af18000) root@archlinux ~/taichi (git)-[ti-init-toggle-advanced-optimization] # ldd /usr/lib/python3.8/site-packages/taichi/lib/libtaichi_core.so linux-vdso.so.1 (0x00007ffea8717000) libpthread.so.0 => /usr/lib/libpthread.so.0 (0x00007fde51926000) libstdc++.so.6 => /usr/lib/libstdc++.so.6 (0x00007fde51749000) libX11.so.6 => /usr/lib/libX11.so.6 (0x00007fde51608000) librt.so.1 => /usr/lib/librt.so.1 (0x00007fde515fd000) libm.so.6 => /usr/lib/libm.so.6 (0x00007fde514b8000) libz.so.1 => /usr/lib/libz.so.1 (0x00007fde5149e000) libdl.so.2 => /usr/lib/libdl.so.2 (0x00007fde51496000) libtinfo.so.5 => /usr/lib/libtinfo.so.5 (0x00007fde51432000) libc.so.6 => /usr/lib/libc.so.6 (0x00007fde5126b000) /usr/lib64/ld-linux-x86-64.so.2 (0x00007fde55313000) libgcc_s.so.1 => /usr/lib/libgcc_s.so.1 (0x00007fde51251000) libxcb.so.1 => /usr/lib/libxcb.so.1 (0x00007fde51227000) libXau.so.6 => /usr/lib/libXau.so.6 (0x00007fde51222000) libXdmcp.so.6 => /usr/lib/libXdmcp.so.6 (0x00007fde51218000)

rexwangcc · 2020-07-04T20:25:44Z

python/taichi/core/util.py

@@ -56,10 +56,9 @@ def import_ti_core(tmp_dir=None):
 def locale_encode(s):
    try:
        import locale
-        encoding = locale.getdefaultlocale()[1]
+        return s.encode(locale.getdefaultlocale()[1])


Just FYI in some rare Linux setups, such as the Ubuntu docker base image, locale.getdefaultlocale()[1] will return None thus s.encode will fail, which is why:
https://github.com/taichi-dev/taichi/pull/1385/files#diff-3254677a7917c6c01f55212f86c57fbfR57
is needed.

Yes, so I changed this to make LANG=C work.

👍 Would be even more clear to catch the specific error (TypeError)

docs/dev_install.rst

Eydcao

Overall looks great! I left a tiny comment.

Co-authored-by: Chengchen(Rex) Wang <14366016+rexwangcc@users.noreply.github.com> Co-authored-by: Yadi Cao <elliott.yd.cao@outlook.com>

archibate · 2020-07-05T05:56:42Z

@yuanming-hu I partially removed LLVM 8 from installation doc (at least make LLVM 10 to be the major one), which you said to be out-of-support very soon, am I doing correct?

zhai-xiao

LGTM

rexwangcc · 2020-07-06T01:53:03Z

python/taichi/core/util.py

@@ -56,10 +56,9 @@ def import_ti_core(tmp_dir=None):
 def locale_encode(s):
    try:
        import locale
-        encoding = locale.getdefaultlocale()[1]
+        return s.encode(locale.getdefaultlocale()[1])


👍 Would be even more clear to catch the specific error (TypeError)

python/taichi/core/util.py

Co-authored-by: Chengchen(Rex) Wang <14366016+rexwangcc@users.noreply.github.com>

archibate · 2020-07-06T09:00:25Z

@yuanming-hu Hello? Could you take a look? I deleted part of LLVM 8 installation doc, hope this work.

yuanming-hu

Thank you so much! Looks great. I think we should drop LLVM 8.0.1 in this PR. Feel free to merge after the comments are addressed. Sorry about my delayed reply.

docs/dev_install.rst

python/taichi/core/util.py

docs/dev_install.rst

Co-authored-by: Yuanming Hu <yuanming-hu@users.noreply.github.com>

…chi-dev/taichi into dev-install-doc-improvements

archibate and others added 25 commits June 27, 2020 14:46

Update dev_install.rst

dfe5fc5

Update install.rst

e3cdd50

Update util.py

31b8dce

[skip ci]

b78b976

[skip ci]

1cbf61b

[skip ci]

904e0fd

[skip ci]

5eba43e

[skip ci] Update docs/dev_install.rst

434cf69

what

b482303

merge master

5eda87d

Merge branch 'master' into dev-install-doc-improvements

262d7e0

[skip ci] m

e3a5fff

[skip ci] try fix

13698b1

[skip ci] name nit

3e1c469

[skip ci] fix

94d47d1

[skip ci]

93273f6

Update kernel_arguments.py

5ca77f9

Update test_function_parameter_by_value.py

625fd89

[skip ci] try to fix

f6731e2

try fix

3abe28e

Merge branch 'master' into dev-install-doc-improvements

0a97cff

[skip ci] Apply suggestions from code review

073393d

Co-authored-by: Yuanming Hu <yuanming-hu@users.noreply.github.com>

[skip ci] nit

2311e88

merge

139e32b

[skip ci] apply

ffb691e

archibate requested review from yuanming-hu, k-ye, zhai-xiao, Eydcao and taichi-gardener July 3, 2020 14:48

archibate added 2 commits July 5, 2020 02:14

Merge branch 'master' into dev-install-doc-improvements

9584006

[skip ci] apply

59df036

archibate requested review from zhai-xiao and k-ye July 4, 2020 18:24

rexwangcc approved these changes Jul 4, 2020

View reviewed changes

archibate self-assigned this Jul 5, 2020

Eydcao reviewed Jul 5, 2020

View reviewed changes

docs/dev_install.rst Outdated Show resolved Hide resolved

Eydcao approved these changes Jul 5, 2020

View reviewed changes

archibate and others added 4 commits July 5, 2020 13:10

Merge branch 'master' into dev-install-doc-improvements

8858482

[skip ci] Apply suggestions from code review

2df7c0d

Co-authored-by: Chengchen(Rex) Wang <14366016+rexwangcc@users.noreply.github.com> Co-authored-by: Yadi Cao <elliott.yd.cao@outlook.com>

[skip ci] apply

97b251c

[skip ci] deprecate llvm-8 from install doc

7062a2f

archibate requested a review from rexwangcc July 5, 2020 06:10

[skip ci] doc #1413

894d788

zhai-xiao approved these changes Jul 5, 2020

View reviewed changes

rexwangcc approved these changes Jul 6, 2020

View reviewed changes

[skip ci] Update python/taichi/core/util.py

701ba7d

Co-authored-by: Chengchen(Rex) Wang <14366016+rexwangcc@users.noreply.github.com>

yuanming-hu approved these changes Jul 10, 2020

View reviewed changes

docs/dev_install.rst Outdated Show resolved Hide resolved

docs/dev_install.rst Outdated Show resolved Hide resolved

python/taichi/core/util.py Outdated Show resolved Hide resolved

docs/dev_install.rst Outdated Show resolved Hide resolved

archibate and others added 3 commits July 10, 2020 11:33

merge master

1c9cbd4

[skip ci] Apply suggestions from code review

f022821

Co-authored-by: Yuanming Hu <yuanming-hu@users.noreply.github.com>

Merge branch 'dev-install-doc-improvements' of https://github.com/tai…

46c810a

…chi-dev/taichi into dev-install-doc-improvements

archibate added LGTM and removed waiting for reply labels Jul 10, 2020

[skip appveyor] Use LLVM 10.0.0 for MacOS

789282a

archibate merged commit 02d89dc into master Jul 10, 2020

FantasyVR mentioned this pull request Jul 11, 2020

[release] v0.6.18 #1459

Merged

yuanming-hu mentioned this pull request Jul 12, 2020

[doc] Fix LLVM version in dev_install.rst #1472

Merged

k-ye deleted the dev-install-doc-improvements branch March 17, 2021 06:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[doc] Improve the developer installation documentation #1388

[doc] Improve the developer installation documentation #1388

archibate commented Jul 3, 2020

rexwangcc left a comment

rexwangcc Jul 4, 2020

archibate Jul 5, 2020

rexwangcc Jul 4, 2020

archibate Jul 5, 2020

rexwangcc Jul 4, 2020

archibate Jul 5, 2020

rexwangcc Jul 6, 2020

Eydcao left a comment

archibate commented Jul 5, 2020

zhai-xiao left a comment

rexwangcc Jul 6, 2020

archibate commented Jul 6, 2020

yuanming-hu left a comment

[doc] Improve the developer installation documentation #1388

[doc] Improve the developer installation documentation #1388

Conversation

archibate commented Jul 3, 2020

rexwangcc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Eydcao left a comment

Choose a reason for hiding this comment

archibate commented Jul 5, 2020

zhai-xiao left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

archibate commented Jul 6, 2020

yuanming-hu left a comment

Choose a reason for hiding this comment