Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yuanming-hu authored Sep 25, 2019
1 parent 977ee0b commit 902f8db
Showing 1 changed file with 6 additions and 27 deletions.
33 changes: 6 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,20 @@
# The **Taichi** Programming Language
### High-Performance Computing on Spatially Sparse Data Structures

# [Python Frontend Tutorial](https://github.com/yuanming-hu/taichi_lang/blob/master/python/README.md#the-taichi-python-frontend)
# DiffSim Programming Language
### Differentiable Physical Simulation

# Installation
Supports Ubuntu 14.04/16.04/18.04, ArchLinux, Mac OS X. For GPU support, CUDA 9.0+ is needed.

- Execute `python3 -m pip install astpretty astor pytest opencv-python pybind11==2.2.4`
- Install `taichi` with the [installation script](https://taichi.readthedocs.io/en/latest/installation.html#ubuntu-arch-linux-and-mac-os-x). **Checkout branch `llvm`**.
- (Optional) If you use the experimental LLVM backend, make sure you have LLVM 8 built from scratch, with
```
mkdir build
cd build
cmake .. -DLLVM_ENABLE_RTTI:BOOL=ON -DBUILD_SHARED_LIBS:BOOL=ON -DCMAKE_BUILD_TYPE=Release -DLLVM_TARGETS_TO_BUILD="X86;NVPTX" -DLLVM_ENABLE_ASSERTIONS=ON
make -j 8
sudo make install
```
- Execute `ti install https://github.com/yuanming-hu/taichi_lang` to install the DSL project
- Install `taichi` with the [installation script](https://taichi.readthedocs.io/en/latest/installation.html#ubuntu-arch-linux-and-mac-os-x). **Checkout branch `llvm-debug`**.
- Put this repo under `taichi/projects/`
- Add the following line to your `~/.bashrc` or `~/.zshrc` for the python frontend.
```bash
export PYTHONPATH=$TAICHI_REPO_DIR/projects/taichi_lang/python:$PYTHONPATH
```
- Execute `source ~/.bashrc` (or `source ~/.zshrc`) to reload shell config.
- Execute `ti build` to build.
- Execute `ti test` to run all the tests. It may take a around 20 minutes to run all tests.
- Check out `examples` for runnable examples. Run them with `python3`.
- Check out `examples` for runnable DiffSim examples. Run them with `python3`.

# Folder Structure
Key folders are
@@ -43,15 +34,3 @@ Key folders are
# Troubleshooting
- Run with debug mode to see if there's any illegal memory access;
- Disable compiler optimizations to quickly confirm that the issue is not cause by optimization;

# Bibtex
```
@inproceedings{hu2019taichi,
title={Taichi: A Language for High-Performance Computation on Spatially Sparse Data Structures},
author={Hu, Yuanming and Li, Tzu-Mao and Anderson, Luke and Ragan-Kelley, Jonathan and Durand, Fr\'edo},
booktitle={SIGGRAPH Asia 2019 Technical Papers},
pages={201},
year={2019},
organization={ACM}
}
```

0 comments on commit 902f8db

Please sign in to comment.