Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Field description of echemdb datapackages #26

Open
DunklesArchipel opened this issue Sep 17, 2022 · 0 comments
Open

Field description of echemdb datapackages #26

DunklesArchipel opened this issue Sep 17, 2022 · 0 comments

Comments

@DunklesArchipel
Copy link
Member

DunklesArchipel commented Sep 17, 2022

Some thoughts on creating a metadata standard for the field description in the echemdb datapackage.

From frictionless fields schema

{
  "name": "name of field (e.g. column name)",
  "title": "A nicer human readable label or title for the field",
  "type": "A string specifying the type",
  "format": "A string specifying a format",
  "example": "An example value for the field",
  "description": "A description for the field",
  "constraints": {
      // a constraints-descriptor
  }
}

echemdb should have something like this:

{
  "name": "name of field (e.g. column name)",
  "title": "A nicer human readable label or title for the field",
  "dimension": "The dimension of the field",
  "unit": "The unit of the field",
  "description": "A description for the field",
  "reference": "Applicable to fields with a potential",
}

currently, it looks somewhat like this:

names = ['t', 'E', 'I', 'j']

Since they should be unique 'E' is not so smart since
it can be E of the working electrode or E of a secondary electrode.
(the same thing applies to j and I)
't' could also be the absolute time or the relative time.

I suggest the following change suggestion:

names = ['t_rel', 't_abs', 'E_WE', 'E_CE', 'E_collector', 'j_WE', 'j_CE']
# the titles could be composed of 'dimension' and 'unit'. 
# Here we do not distinguish between working and counter elecrode
title = ['t [s]', 'E [V vs Ref]', 'E [V]']
# the description could contain more information on the field
description_E_WE = 'Working electrode potential'
description_j_collector = 'current density at the ring electrode'

# what we need for echemdb (including things that might come and are already relevant in the lab)
names = ['t_rel', 't_abs', 
         'E_WE', 'E_CE', 'E_collector', 
         'j_WE', 'j_CE', 'j_collector',
         'I_WE', 'I_CE', 'I_collector']

Finally an example:

fields:
 - name: t_rel
   original name: time (s) 
   title: t [s]
   dimension: t
   unit: s
   description: The relative time with respect to the first data point in this series.
 - name: E_WE2
   original name: WE(2).potential (V)
   title: E [V vs RHE]
   dimension: E
   unit: V
   description: Potential at the secondary collector electrode.
   reference: RHE
   
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant