Skip to content
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.

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

Add additional cycler parsers #151

Merged
merged 29 commits into from
Oct 21, 2024
Merged

Add additional cycler parsers #151

merged 29 commits into from
Oct 21, 2024

Conversation

tomjholland
Copy link
Collaborator

@tomjholland tomjholland commented Oct 16, 2024

This pull request includes the addition of support for new cyclers, updates to the user guide documentation, and improvements to the BaseCycler class. The most important changes include adding support for Arbin, Maccor, and Basytec cyclers, updating the documentation to reflect these new cyclers, and refining the data validation and import processes.

Support for New Cyclers:

  • Added support for Arbin, Maccor, and Basytec cyclers in the pyprobe/cell.py by importing their respective modules and adding them to the cycler_dict in the process_cycler_file function. [1] [2].
  • Introduced the pyprobe/cyclers/arbin.py module to handle Arbin battery cycler data, including defining the Arbin class with appropriate column mappings.
  • Introduced the pyprobe/cyclers/maccor.py module to handle Maccor battery cycler data. Closes Add maccor preprocessor #10
  • Introduced the pyprobe/cyclers/basytec.py module to handle Basytec battery cycler data.

Documentation Updates:

  • Updated the docs/source/user_guide/input_data_guidance.rst to include information about the new cyclers and their supported file formats.
  • Enhanced the data columns table in the documentation to include columns for Arbin, Maccor, and Basytec, and added a scrollable table style for better readability.

Improvements to BaseCycler Class:

  • Added new field validators and model validators to the BaseCycler class in pyprobe/cyclers/basecycler.py to ensure the validity of input data paths and column dictionaries. Closes Improve error reporting when PyProBE is unable to find required column in cycler file #140
  • Refined the _map_columns method to include default units and improved the handling of temperature units.
  • Updated the pyprobe_dataframe method to handle optional columns more gracefully and ensure proper formatting of date and capacity columns. [1] [2] [3]

@tomjholland tomjholland added the feature Adding a new functionality, small or large label Oct 18, 2024
@tomjholland tomjholland marked this pull request as ready for review October 21, 2024 10:13
@tomjholland tomjholland merged commit df72274 into main Oct 21, 2024
3 checks passed
@tomjholland tomjholland deleted the add-more-cyclers branch October 21, 2024 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Adding a new functionality, small or large
Projects
None yet
1 participant