https://github.com/chazeon/vasp-docset
Tools to build a VASP docset
https://github.com/chazeon/vasp-docset
ab-initio dash-docset docset quantum-chemistry vasp
Last synced: about 2 months ago
JSON representation
Tools to build a VASP docset
- Host: GitHub
- URL: https://github.com/chazeon/vasp-docset
- Owner: chazeon
- License: mit
- Created: 2022-04-27T20:18:48.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-29T16:11:05.000Z (about 4 years ago)
- Last Synced: 2025-09-05T20:01:11.851Z (9 months ago)
- Topics: ab-initio, dash-docset, docset, quantum-chemistry, vasp
- Language: CSS
- Homepage:
- Size: 731 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VASP Docset
[VASP](https://www.vasp.at/) (Vienna _ab initio_ simulation package) docset for [Dash](http://kapeli.com/dash/).
## How to scrape and build docset
First, install the required dependencies
```
python3 -m pip install -r requirements.txt
```
then run the scripts
```bash
mkdir -p vasp.docset/Contents/Resources/Documents
python3 scripts/scrape.py
python3 scripts/vaspdoc2set.py
```
## Prebuilt docset
[](https://github.com/chazeon/vasp-docset/actions/workflows/build.yml)
- Avaliable as [GitHub Action Artifact](https://github.com/chazeon/vasp-docset/actions/workflows/build.yml) (or via [direct link](https://nightly.link/chazeon/vasp-docset/workflows/build/master/vasp.tgz.zip)).
## Licence
- The code is licenced under the [MIT Licence](LICENCE).
- The original VASP document is licenced under [GNU Free Documentation License 1.2](https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt).