jupytext | kernelspec | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
The electrochemical data shown on the echemdb.org website can be stored in a collection.
from unitpackage.cv.cv_collection import CVCollection
db = CVCollection.from_remote()
type(db)
In contrast to the Collection
object described in the usage section, CVCollection
provides data specific functionality. All other functionalities of the base class also apply here.
For example, statistics of the collection can be shown.
Show statistics of the collection
db.describe()
The entries have properties which allow for more convenient filtering of the collection.
db_filtered = db.filter(lambda entry: entry.get_electrode('WE').material == 'Pt')
db_filtered.describe()
Single entries can be selected by their identifier provided on echemdb.org for each entry.
entry = db['engstfeld_2018_polycrystalline_17743_f4b_1']
type(entry)
entry.package
provides a full list of available descriptors.
As indicated above, electrodes used to record the data are listed in the system.electrodes
descriptor and are accessible with
entry.get_electrode('WE')
Usually measurements are performed in a three electrode configuration, with a working electrode `WE`, a counter electrode `CE`, and a reference electrode `REF`.
In a freshly created collection all values of in the dataframe are in SI units.
entry.df.head(5)
The original units in the published figure are stored as metadata.
entry.figure_description
An entry can be rescaled to these original units.
original_entry = entry.rescale('original')
original_entry.df.head(5)
The default plot to present the data is j
vs. E
(or I
vs. E
).
The curve label consists of the figure number in the original publication followed by a unique identifier.
entry.plot()
The dimensions of the axis can still be specified explicitly.
entry.plot(x_label='t', y_label='j')
All entries within the CVCollection
are referenced and included in a bibtex bibliography.
len(db.bibliography.entries)
Each entry in the echemdb collection can be cited.
entry = db['engstfeld_2018_polycrystalline_17743_f4b_1']
entry.citation(backend='text') # other available backends: 'latex' or 'markdown'. 'text' is default.