From 1b8f1bb536066b5876447608cb8a6b9f8ac365e9 Mon Sep 17 00:00:00 2001 From: Tom Holland Date: Fri, 13 Sep 2024 13:37:19 +0100 Subject: [PATCH 1/2] Add html suffix to filtering data readme link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b976077d..75758d8d 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ cell.procedure['Reference Test'].step(1) cell.procedure['Reference Test'].experiment('Discharge Pulses').cycle(3).discharge(0) ``` -This makes it easy to quickly access the data you need for analysis. See the [filtering data](https://congenial-adventure-mz797n5.pages.github.io/examples/filtering-data>) example to see this in action. +This makes it easy to quickly access the data you need for analysis. See the [filtering data](https://congenial-adventure-mz797n5.pages.github.io/examples/filtering-data.html) example to see this in action. See the [documentation](https://congenial-adventure-mz797n5.pages.github.io) for a detailed user guide. Start with the following pages to get PyProBE set up with your data: - [Importing data](https://congenial-adventure-mz797n5.pages.github.io/user_guide/importing_data.html) From b247934096b9d140555a247ee7d2094b0b42bc11 Mon Sep 17 00:00:00 2001 From: Tom Holland Date: Fri, 13 Sep 2024 13:42:53 +0100 Subject: [PATCH 2/2] Add that user must run getting started example locally for GUI --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 75758d8d..7bd68da9 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,8 @@ PyProBE works with numerous cyclers. For guidance on how to export your data to 2. Accelerate battery data exploration PyProBE has a built-in [plotting](https://congenial-adventure-mz797n5.pages.github.io/api/pyprobe.plot.html) module for fast and flexible visualisation of battery data. It also includes a graphical user interface (GUI) -for exploring data interactively, with almost no code. See the -[getting started](./docs/source/examples/getting-started.ipynb) example to try the GUI. +for exploring data interactively, with almost no code. Run the +[getting started](./docs/source/examples/getting-started.ipynb) example locally to try the GUI. ![PyProBE Dashboard](./docs/source/user_guide/images/Dashboard.png)