No multi-thread instructions in user guide
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 41
- Forks
- 88
- Avg merge
- 8d 9h
- Merged PRs (30d)
- 3
Description
Surprisingly I found there's almost no documentation for the usage of lib.num_threads() or environment variables in the quick start or user guide (I've searched "thread" and "openmp"). Although this is common knowledge for experienced pyscf users, I believe there should be a few words for multi-thread instructions for starters.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the quick start and user guide pages, then search them for existing references to lib.num_threads(), thread, and openmp. Done means the documentation explains multi-thread usage and relevant environment variables clearly for starters in the affected guide sections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100