Skip to content

docs: clarify Neware nda loading via fastnda #723

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.

Sign up for GitHub

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

Merged
jepegit merged 1 commit into from
Jul 26, 2026
+14 −2
Merged

docs: clarify Neware nda loading via fastnda #723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions HISTORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## [Unreleased]

* Clarify Neware docs: binary `.nda`/`.ndax` via `neware_nda` (bundled fastnda) vs exported `neware_txt` models.

* Iterative docs fixes: example notebook typos/hedges, GITT intro quote, and batch config note for 1.x vs `cellpy.toml`. (#695).

## [2.0.0] - 2026-07-26
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/06_loading_different_formats.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45644,7 +45644,7 @@
"id": "d9f8058d-4814-4300-a115-03fc902fc33b",
"metadata": {},
"source": [
"Neware support is limited today: one `model` is implemented (\"ONE\"). Using the method described above for getting information, currently you will see three model names appear. The \"default\" is the one that will be picked if no model name is provided (\"ONE\" for now), while \"UIO\" is just a nickname for the \"ONE\" model."
"Neware shows up in two ways:\n\n- **Binary `.nda` / `.ndax`** — load with `instrument=\"neware_nda\"`. That path uses a bundled [fastnda](https://pypi.org/project/fastnda/)-based reader (`cellpy.libs.local_fastnda`).\n- **Exported text/CSV** — load with `instrument=\"neware_txt\"` and a `model` for the export layout. The model names below (`ONE` / `UIO`, …) apply only to that text loader.\n\n```python\nc = cellpy.get(\"my_cell.nda\", instrument=\"neware_nda\")\n```\n\nFor exported Neware files, the default text `model` is `\"ONE\"` (`\"UIO\"` is a nickname for the same layout). Using the method above for instrument info, you will also see those model names listed under `neware_txt`:\n"
]
},
{
Expand Down
12 changes: 11 additions & 1 deletion docs/examples/06_loading_different_formats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,17 @@ plotutils.summary_plot(c, y="capacities", width=1200, height=400, y_range=[0, 10

## NEWARE

Neware support is limited today: one `model` is implemented ("ONE"). Using the method described above for getting information, currently you will see three model names appear. The "default" is the one that will be picked if no model name is provided ("ONE" for now), while "UIO" is just a nickname for the "ONE" model.
Neware shows up in two ways:

- **Binary `.nda` / `.ndax`** — load with `instrument="neware_nda"`. That path uses a bundled [fastnda](https://pypi.org/project/fastnda/)-based reader (`cellpy.libs.local_fastnda`).
- **Exported text/CSV** — load with `instrument="neware_txt"` and a `model` for the export layout. The model names below (`ONE` / `UIO`, …) apply only to that text loader.

```python
c = cellpy.get("my_cell.nda", instrument="neware_nda")
```

For exported Neware files, the default text `model` is `"ONE"` (`"UIO"` is a nickname for the same layout). Using the method above for instrument info, you will also see those model names listed under `neware_txt`:



```python
Expand Down
Loading