Skip to content

Commit 094983a

Browse files
g-kimbellml-evs
authored andcommitted
Add fastnda extractor
1 parent be51e6c commit 094983a

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

yard/data/extractors/fastnda.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
id: >-
3+
fastnda
4+
name: >-
5+
fastnda
6+
description: >-
7+
Python module and command line tool to read Neware NDA and NDAX battery
8+
cycling files.
9+
supported_filetypes:
10+
- id: neware-nda
11+
license:
12+
spdx: BSD-3-Clause
13+
subject:
14+
- electrochemistry
15+
- voltammetry
16+
citations:
17+
- uri: https://github.com/EmpaEConversion/fastnda
18+
creators:
19+
- G. Kimbell
20+
title: fastnda github repository
21+
type: software
22+
source_repository: https://github.com/EmpaEConversion/fastnda
23+
usage:
24+
- method: python
25+
setup: fastnda
26+
command: fastnda.read({{ input_path }})
27+
- method: cli
28+
command: fastnda --help
29+
- method: cli
30+
command: fastnda convert {{ input_path }} {{ output_path }}
31+
- method: cli
32+
command: fastnda convert-metadata {{ input_path }} {{ output_path }}
33+
installation:
34+
- method: pip
35+
packages:
36+
- fastnda >= 1.0.1
37+
requires_python: '>=3.10'
38+
instructions: >-
39+
Install the package into a Python >=3.10 environment with
40+
`pip install fastnda`. After activating the environment, the `fastnda`
41+
entrypoint will be available on the command-line.
42+
43+
With Python, use `fastnda.read(file)` or `fastnda.read_metadata(file)`.
44+
With the CLI, commands are `convert`, `batch-convert`, and
45+
`convert-metadata`. Use `fastnda --help` and fastnda COMMAND --help to see
46+
detailed options.

0 commit comments

Comments
 (0)