Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/echemdb/website
Tools for building the echemdb website.
https://github.com/echemdb/website
database electrochemistry website-template
Last synced: 10 days ago
JSON representation
Tools for building the echemdb website.
- Host: GitHub
- URL: https://github.com/echemdb/website
- Owner: echemdb
- License: gpl-3.0
- Created: 2021-05-04T14:54:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-24T23:22:28.000Z (9 months ago)
- Last Synced: 2024-04-25T01:42:02.000Z (8 months ago)
- Topics: database, electrochemistry, website-template
- Language: Python
- Homepage: https://www.echemdb.org
- Size: 12 MB
- Stars: 3
- Watchers: 2
- Forks: 8
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
The [echemdb repository](https://github.com/echemdb/website) contains high
quality experimental and theoretical data on electrochemical systems. The
standardized and validated data displayed on the [projects
website](https://www.echemdb.org/) so far is from the community and
publications aiming at fullfilling the [FAIR
principles](https://www.go-fair.org/fair-principles/).
The repository can be browsed on [our
websites](https://www.echemdb.org/) or explored with a [Python
API](https://github.com/echemdb/echemdb).
# For developers
The build of the website can be tested locally with the following steps.
## Installation
Clone the repository
```sh
git clone [email protected]:echemdb/website.git
```
Install dependencies (mamba or conda)
```sh
cd website
mamba env create --file environment.yaml
mamba activate echemdb-website
pip install -e .
```
## Build website
```sh
mkdcos serve
```
The generated HTML files are located in `generated/website`
Entries for the individual cyclic voltammograms are created from datapackaes in `data/generated/svgdigitizer`. Follow the next section to create such data.
## Convert literature to datapackages
To digitize all data
```sh
cd data
make
```
To run the svgdigitizer in parallel on 8 cores, use instead
```sh
make -j8
```
We can also only digitize a single data set
```sh
make generated/svgdigitizer/mello_2018_understanding_J3045/mello_2018_understanding_J3045_p1_f1H_black.csv
```
To digitize data from a different source directory than
`literature/` use
```sh
make SOURCE_DIR=/another/path
```
## Code changes
If you make changes to the code test the modules with
```sh
pytest --doctest-modules website
pylint website
isort website
black website
```
# License
The contents of this repository are licensed under the [GNU General Public
License v3.0](./LICENSE) or, at your option, any later version. The contents
of [data/](./data/) and [literature/](./literature/) are additionally licensed
under the [Creative Commons Attribution 4.0 International
License](https://creativecommons.org/licenses/by/4.0/).