Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ jobs:
# * ignore fonts.gstatic.com which is mentioned by a link preconnect tag that linkchecker does not parse correctly.
# * ignore DOIs since some publishers ban GitHub or bots.
# * ignore datascience.codata.org because this host intermittently times out.
pixi run linkchecker --check-extern --no-robots --ignore fonts.gstatic.com --ignore doi.org --ignore datascience.codata.org http://localhost:8880/ --ignore mybinder.org --ignore osti.gov --no-warnings
# * ignore go-fair.org because it returns 403 for automated requests.
pixi run linkchecker --check-extern --no-robots --ignore fonts.gstatic.com --ignore doi.org --ignore datascience.codata.org http://localhost:8880/ --ignore mybinder.org --ignore osti.gov --ignore go-fair.org --no-warnings
# We only check links on Linux since we do not want to get flagged because of too many requests by the target websites.
if: ${{ matrix.os == 'ubuntu-latest' }}
- uses: JamesIves/github-pages-deploy-action@v4.3.3
Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ extra_css:

plugins:
- search
- macros
- macros:
module_name: website/macros/__init__
- gen-files:
scripts:
- website/generator/__main__.py
Expand Down
34 changes: 28 additions & 6 deletions pages/cv/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,28 @@
# Cyclic Voltammograms

The cyclic voltammograms (CVs[^1]) are categorized based on the type of system,
i.e., aquoues or non-aqueous, as well as descriptors (tags) used to some extent
commonly by the community or introduced here for the purpose of categorizing the systems.
An entry can have several tags.
This Section shows the content of the [electrochemistry-data](https://github.com/echemdb/electrochemistry-data)
repository, containing cyclic voltammograms (CVs[^1]) for single crystal electrodes (using dataset version {{ ECHEMDB_DATABASE_VERSION }}).

The CVs are sorted based ony categories relevant to certain communities
such as the type of electrolyte, i.e., aquoues or non-aqueous,
as well as tags used for categorizing the systems.

## Database Access

The data shown on this website can either be downloaded directly as a ZIP from the
release section of the [electrochemistry-data](https://github.com/echemdb/electrochemistry-data) repository.

Alternatively, the dataset can be downloaded using the [unitpackage API](https://echemdb.github.io/unitpackage/usage/echemdb_usage.html).
The API also allows browsing, filtering and manipulating the database, which is described in detail in the API documentation.

To create, browse and compare specific datasets based on other search criteria,
use the [API](https://echemdb.github.io/echemdb/).
Example usage to download the database using the API:

```python
from unitpackage.database.echemdb import Echemdb

db = Echemdb.from_remote(version="{{ ECHEMDB_DATABASE_VERSION }}")
db.describe()
```

## Systems

Expand All @@ -18,6 +34,12 @@ as in **[Ionic Liquids](ionic_liquid.md)**, or it consists of a non-conductive s

## Tags

We use common tags used by the community or new (or less known) ones
for the purpose of categorizing the systems.
An entry can have several tags.

Currently available tags are:

* **BCV**: We consider a "base cyclic voltammogram" as a CV that shows no electrocatalysis except possibly the decomposition of the electrolyte.
* **SHA**: Specific Halide Adsorption, studied in electrolytes containing at least one halide component.
* **COOR**: CO Oxidation Reaction, usually studied in a CO saturated electrolyte.
Expand Down
10 changes: 10 additions & 0 deletions website/macros/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,13 @@ def enable_macros(env):
from website.macros.render import render

env.macro(render)


def define_env(env):
r"""
Register variables and macros for use in mkdocs-macros templates.
"""
from website.generator.database import ECHEMDB_DATABASE_VERSION

env.variables["ECHEMDB_DATABASE_VERSION"] = ECHEMDB_DATABASE_VERSION
enable_macros(env)
Loading