Skip to content

Commit

Permalink
Merge pull request #138 from ImperialCollegeLondon/pre-submission-fixes
Browse files Browse the repository at this point in the history
Update links with new github pages site address
  • Loading branch information
tomjholland authored Sep 16, 2024
2 parents 571772e + 81d2840 commit 9ecc662
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ If you have a suggestion, please open an issue describing in detail the change y

If you would like to contribute code, please:

1. Install PyProBE with [developer settings](https://congenial-adventure-mz797n5.pages.github.io/developer_guide/developer_installation.html)
1. Install PyProBE with [developer settings](https://imperialcollegelondon.github.io/PyProBE/developer_guide/developer_installation.html)

2. Open an issue to detail the change/addition you wish to make, unless one already exists

Expand Down Expand Up @@ -38,10 +38,10 @@ Additions to the code should be made in accordance with the structure of PyProBE
maximise compatibility and ensure it is a maintainable package. Guidance for writing
code for PyProBE includes:
1. DataFrame operations should only be done using polars expressions. Data should be kept by default in polars LazyFrame format and only converted to DataFrame if needed for a particular operation.
2. Analysis classes should be written in the format described in the [documentation](https://congenial-adventure-mz797n5.pages.github.io/developer_guide/contributing_to_the_analysis_module.html).
2. Analysis classes should be written in the format described in the [documentation](https://imperialcollegelondon.github.io/PyProBE/developer_guide/contributing_to_the_analysis_module.html).

## Viewing the API documentation

API documentation is built in html format, and stored locally in docs/build/html/. This can be viewed in your browser at docs/build/html/index.html.

The documentation is also continuously deployed via GitHub Actions, and can be viewed [here](https://congenial-adventure-mz797n5.pages.github.io).
The documentation is also continuously deployed via GitHub Actions, and can be viewed [here](https://imperialcollegelondon.github.io/PyProBE/).
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
PyProBE (Python Processing for Battery Experiments) is a Python package designed to simplify and accelerate the process of analysing data from
battery cyclers.

PyProBE is documented [here](https://congenial-adventure-mz797n5.pages.github.io). Examples are stored in ```docs/source/examples``` and are integrated into the documentation [here](https://congenial-adventure-mz797n5.pages.github.io/examples/examples.html).
PyProBE is documented [here](https://imperialcollegelondon.github.io/PyProBE/). Examples are stored in ```docs/source/examples``` and are integrated into the documentation [here](https://imperialcollegelondon.github.io/PyProBE/examples/examples.html).

## Installing PyProBE
Please follow the [user installation guide](https://congenial-adventure-mz797n5.pages.github.io/user_guide/installation.html) to install PyProBE.
Please follow the [user installation guide](https://imperialcollegelondon.github.io/PyProBE/user_guide/installation.html) to install PyProBE.

## PyProBE Objectives
<details open>
Expand All @@ -30,20 +30,20 @@ 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.html) example to see this in action.
This makes it easy to quickly access the data you need for analysis. See the [filtering data](https://imperialcollegelondon.github.io/PyProBE/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)
- [Accessing data](https://congenial-adventure-mz797n5.pages.github.io/user_guide/accessing_data.html)
- [Plotting](https://congenial-adventure-mz797n5.pages.github.io/user_guide/plotting.html)
See the [documentation](https://imperialcollegelondon.github.io/PyProBE/) for a detailed user guide. Start with the following pages to get PyProBE set up with your data:
- [Importing data](https://imperialcollegelondon.github.io/PyProBE/user_guide/importing_data.html)
- [Accessing data](https://imperialcollegelondon.github.io/PyProBE/user_guide/accessing_data.html)
- [Plotting](https://imperialcollegelondon.github.io/PyProBE/user_guide/plotting.html)

PyProBE works with numerous cyclers. For guidance on how to export your data to work with PyProBE see the [Input Data Guidance](https://congenial-adventure-mz797n5.pages.github.io/user_guide/input_data_guidance.html).
PyProBE works with numerous cyclers. For guidance on how to export your data to work with PyProBE see the [Input Data Guidance](https://imperialcollegelondon.github.io/PyProBE/user_guide/input_data_guidance.html).
</details>

<details>
<summary><strong style="font-size: 1.2em;">2. Accelerate battery data exploration</strong></summary>

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)
PyProBE has a built-in [plotting](https://imperialcollegelondon.github.io/PyProBE/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. Run the
[getting started](./docs/source/examples/getting-started.ipynb) example locally to try the GUI.

Expand All @@ -69,14 +69,14 @@ makes the setup process fast and intuitive for new data.

![README file](./docs/source/user_guide/images/Readme.jpg)

See the [guidance](https://congenial-adventure-mz797n5.pages.github.io/user_guide/writing_a_readme_file.html) for writing README files for your
See the [guidance](https://imperialcollegelondon.github.io/PyProBE/user_guide/writing_a_readme_file.html) for writing README files for your
experiments.
</details>

<details>
<summary>4. <strong style="font-size: 1.2em;">Host a library of analysis methods</strong></summary>

PyProBE's [analysis](https://congenial-adventure-mz797n5.pages.github.io/api/pyprobe.analysis.html) module contains classes and methods to
PyProBE's [analysis](https://imperialcollegelondon.github.io/PyProBE/api/pyprobe.analysis.html) module contains classes and methods to
perform further analysis of battery data. It is designed to maintain compatibility
with the PyProBE data format and plotting tools while ensuring functions are simply
defined, portable and tested.
Expand All @@ -96,7 +96,7 @@ The currently implemented analysis methods includes:
- Curve fitting to pseudo-OCV, Incremental Capacity Analysis (ICA) or Differential Voltage Analysis (DVA) curves
- Charge/discharge pseudo-OCV curve averaging for resistance compensation

It is easy to contribute to the analysis module. See the [developer guide](https://congenial-adventure-mz797n5.pages.github.io/developer_guide/contributing_to_the_analysis_module.html)
It is easy to contribute to the analysis module. See the [developer guide](https://imperialcollegelondon.github.io/PyProBE/developer_guide/contributing_to_the_analysis_module.html)
and [contributing guidelines](CONTRIBUTING.md).
</details>

Expand Down

0 comments on commit 9ecc662

Please sign in to comment.