PTEROSOR/QUESTDB_website
10
0
Fork 0
mirror of https://github.com/LCPQ/QUESTDB_website.git synced 2024-12-26 06:14:38 +01:00
Code Releases Activity

Add README.md

Browse Source
This commit is contained in:
Mickaël Véril 2020-09-11 11:58:33 +02:00
parent 169f385c42
commit bc3a86bde6
1 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md Normal file
View File

@ -0,0 +1,38 @@
# QUEST Website
## Introduction
The QUEST website is the website build to analyze the date from the [QUEST project](https://doi.org/10.1021/acs.jpclett.0c00014). it provide statistics for the QUEST vertical excitations set by targeting data corresponding to the parameters which the user has selected.
## Quick start
To clone this website and use it locally please run the following commands.
```bash
git clone --recurse-submodules https://git.irsamc.ups-tlse.fr/mveril/exdatabaseLCPQ
cd exdatabaseLCPQ
hugo serve
```
Now you car use your favorite browser to navigate to the website using the URL showed by hugo in your terminal (normally <localhost:1313>)
## Repository content
### The website
The main part of this repository is the website. It is build using the [hugo](https://gohugo.io/) static website generator with the [beautifulhugo](https://themes.gohugo.io/beautifulhugo/) theme.
All the data are stored in the [data](static/data) directory.
### The tools.
The second part is the [tools](tools/) a series of python and bash scripts used to generate data.
#### datafileBuilder
A python script to generate data from custom \LaTeX input file see [examples](docs/examples).
#### metarecover
the metarecover bash script is used to regenerate the metadata from the previous git history state.
So you can remove a data file to regenerate it from a LaTeX input file with datafileBuilder and recover the metadata from the previous version using metarecover.