This repository has been archived by the owner on May 31, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
Add NewareNDA extractor entry #78
Closed
+50
−0
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| id: >- | ||
| NewareNDA | ||
| name: >- | ||
| NewareNDA | ||
| description: >- | ||
| Python module and command line tool for reading and converting Neware nda and ndax battery cycling data files. | ||
| supported_filetypes: | ||
| - id: neware-nda | ||
| license: | ||
| spdx: BSD-3-Clause | ||
| uri: https://github.com/Solid-Energy-Systems/NewareNDA/blob/master/LICENSE | ||
| subject: | ||
| - electrochemistry | ||
| citations: | ||
| - uri: https://github.com/Solid-Energy-Systems/NewareNDA | ||
| creators: | ||
| - D. Cogswell | ||
| title: NewareNDA github repository | ||
| type: software | ||
| source_repository: https://github.com/Solid-Energy-Systems/NewareNDA | ||
| usage: | ||
| - method: cli | ||
| command: NewareNDA-cli.py {{ input_path }} --format csv {{ output_path }} | ||
| - method: cli | ||
| command: NewareNDA-cli.py {{ input_path }} --format excel {{ output_path }} | ||
| - method: cli | ||
| command: NewareNDA-cli.py {{ input_path }} --format feather {{ output_path }} | ||
| - method: cli | ||
| command: NewareNDA-cli.py {{ input_path }} --format hdf {{ output_path }} | ||
| - method: cli | ||
| command: NewareNDA-cli.py {{ input_path }} --format json {{ output_path }} | ||
| - method: cli | ||
| command: NewareNDA-cli.py {{ input_path }} --format parquet {{ output_path }} | ||
| - method: cli | ||
| command: NewareNDA-cli.py {{ input_path }} --format pickle {{ output_path }} | ||
| - method: cli | ||
| command: NewareNDA-cli.py {{ input_path }} --format stata {{ output_path }} | ||
| - method: python | ||
| setup: NewareNDA | ||
| command: NewareNDA.read({{ input_path }}) | ||
| installation: | ||
| - method: pip | ||
| packages: | ||
| - NewareNDA >= 2024 | ||
| requires_python: '>=3.6' | ||
| instructions: >- | ||
| Install the package into a Python 3.6+ environment with | ||
| `pip install NewareNDA`. The results will be returned as | ||
| a pandas dataframe. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, what is the python object generated from
NewareNDA.read()below? Is it a dict, or some other object? I think we should probably have the analogous CLI usage (json?) for the python usage for now, instead of having 10 equivalent ones with an output format.Also, we have
output_typein the template: https://marda-alliance.github.io/metadata_extractors_schema/main/mme_schema/UsageTemplate.htmlThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It returns a dataframe at the moment, the CLI then just calls the various
df.to_<x>()functions that pandas has.output_typerequires a MaRDA filetype itself right? I think it's also single-valued (at the moment) so not sure how useful it is hereThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, then we probably need to mention pandas somewhere. I'll think about how to add that into schema (also for the xarray requirement in yadg) in another PR.
And yes, we should probably add those as
FileTypesinto the registry anyway.