Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Add documentation for gui system and install trouble shooting. #2985

Merged
merged 12 commits into from
Oct 8, 2021
2 changes: 1 addition & 1 deletion docs/lang/articles/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ python3 -m pip install taichi
```

:::note
Currently, Taichi only supports Python 3.6/3.7/3.8 (64-bit).
Currently, Taichi only supports Python 3.6/3.7/3.8/3.9 (64-bit).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about we take this opportunity to schedule Taichi's deprecation for 3.6 by 2022 :-)? https://endoflife.date/python @ailzhang @Zheaoli @strongoier

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good! Maybe we should mention that taichi'll do one major verison official release for 3.6 after its EOL and then we'll stop py36 releases?

Copy link
Contributor

@Zheaoli Zheaoli Sep 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds great! Maybe we can make a deprecated roadmap/strategy to get a major version to drop the Python 3.6 support, then we can add log info to show the deprecated warning. After this, the developer will get some information when they execute import taichi in Python 3.6

:::

import Tabs from '@theme/Tabs';
Expand Down
310 changes: 283 additions & 27 deletions docs/lang/articles/misc/gui.md

Large diffs are not rendered by default.

20 changes: 3 additions & 17 deletions docs/lang/articles/misc/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,6 @@ sidebar_position: 0

### Linux issues

- If Taichi crashes and reports `libtinfo.so.5 not found`:

- On Ubuntu, execute `sudo apt install libtinfo-dev`.

- On Arch Linux, first edit `/etc/pacman.conf`, and append these
lines:

```
[archlinuxcn]
Server = https://mirrors.tuna.tsinghua.edu.cn/archlinuxcn/$arch
```

Then execute `sudo pacman -Syy ncurses5-compat-libs`.

- If Taichi crashes and reports
`` /usr/lib/libstdc++.so.6: version `CXXABI_1.3.11' not found ``:

Expand Down Expand Up @@ -49,11 +35,11 @@ sidebar_position: 0
ERROR: No matching distribution found for taichi
```

- Make sure you're using Python version 3.6/3.7/3.8:
- Make sure you're using Python version 3.6/3.7/3.8/3.9:

```bash
python3 -c "print(__import__('sys').version[:3])"
# 3.6, 3.7 or 3.8
# 3.6, 3.7, 3.8 or 3.9
```

- Make sure your Python executable is 64-bit:
Expand All @@ -74,7 +60,7 @@ sidebar_position: 0
[E 05/14/20 10:46:49.911] Received signal 7 (Bus error)
```

This might be because that your NVIDIA GPU is pre-Pascal and it
This might be because that your NVIDIA GPU is pre-Pascal, and it
has limited support for [Unified
Memory](https://www.nextplatform.com/2019/01/24/unified-memory-the-final-piece-of-the-gpu-programming-puzzle/).

Expand Down
Binary file added docs/lang/articles/static/assets/arrow_field.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/lang/articles/static/assets/arrows.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/lang/articles/static/assets/circles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/lang/articles/static/assets/lines.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/lang/articles/static/assets/point_field.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/lang/articles/static/assets/rect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/lang/articles/static/assets/triangles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions python/taichi/misc/gui.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ class GUI:
name (str, optional): The name of the GUI to be constructed.
Default is 'Taichi'.
res (Union[int, List[int]], optional): The resolution of created
GUI. Default is 512*512.
background_color (int, optional): The background color of creted GUI.
GUI. Default is 512*512. If `res` is scalar, then width will be equal to height.
background_color (int, optional): The background color of created GUI.
Default is 0x000000.
show_gui (bool, optional): Specify whether to render the GUI. Default is True.
fullscreen (bool, optional): Specify whether to render the GUI in
Expand Down