`libyt` Document - Githubissues

yt-project / libyt

In-situ analysis with yt

https://libyt.readthedocs.io/

BSD 3-Clause "New" or "Revised" License

9 stars 3 forks source link

`libyt` Document #23

Closed cindytsai closed 2 years ago

cindytsai commented 3 years ago

Document

This document is more like a user guide, and how they can reach developer guide. They will be put inside README.md and libyt/doc folder.

[x] User Guide
- [x] Welcome msg
- [x] guides to reach information.
- [x] Supported yt functionality
- [x] What functionalities will fail. (Even though we have support getting non-local grids and particle data using libyt. See #26 )
- [x] User Guide content table at main readme.
- [x] Example code.

Code Optimize

[x] Make searching in yt_rma_field and yt_rma_particle faster.