{"id":13720470,"url":"https://github.com/Samuel-Buteau/universal-battery-database","last_synced_at":"2025-05-07T12:31:20.055Z","repository":{"id":39735440,"uuid":"215334106","full_name":"Samuel-Buteau/universal-battery-database","owner":"Samuel-Buteau","description":"Open source Li-ion data management and modelling software","archived":false,"fork":false,"pushed_at":"2022-12-08T03:55:17.000Z","size":2151,"stargazers_count":86,"open_issues_count":38,"forks_count":21,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-13T05:33:47.448Z","etag":null,"topics":["deep-learning","lithium-ion","lithium-ion-cells","ml","tensorflow","universal-battery-database"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Samuel-Buteau.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-15T15:33:35.000Z","updated_at":"2025-04-10T02:58:11.000Z","dependencies_parsed_at":"2023-01-25T04:30:44.867Z","dependency_job_id":null,"html_url":"https://github.com/Samuel-Buteau/universal-battery-database","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Samuel-Buteau%2Funiversal-battery-database","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Samuel-Buteau%2Funiversal-battery-database/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Samuel-Buteau%2Funiversal-battery-database/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Samuel-Buteau%2Funiversal-battery-database/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Samuel-Buteau","download_url":"https://codeload.github.com/Samuel-Buteau/universal-battery-database/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248830404,"owners_count":21168272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deep-learning","lithium-ion","lithium-ion-cells","ml","tensorflow","universal-battery-database"],"created_at":"2024-08-03T01:01:04.132Z","updated_at":"2025-05-07T12:31:20.028Z","avatar_url":"https://github.com/Samuel-Buteau.png","language":"Python","funding_links":[],"categories":["Energy Storage"],"sub_categories":["Battery"],"readme":"# Universal Battery Database\n\nThe Universal Battery Database is an open source software for managing Lithium-ion cell data. Its primary purposes are:\n1. Organize and parse experimental measurement (e.g. long term cycling and electrochemical impedance spectroscopy) data files of Lithium-ion cells.\n2. Perform sophisticated modelling using machine learning and physics-based approaches.\n3. Describe and organize the design and chemistry information of cells (e.g. electrodes, electrolytes, geometry), as well as experimental conditions (e.g. temperature).\n4. Automatically refresh a database as new data comes in.\n5. Visualize experimental results.\n6. Quickly search and find data of interest.\n7. Quality control.\n\nThe Universal Battery Database was developed at the [Jeff Dahn Research Group](https://www.dal.ca/diff/dahn/about.html) at Dalhousie University.\n\n## Table of Contents\n\n- [Preliminary Results](#preliminary-results)\n- [Data Management Software Demo](#data-management-software-demo)\n- [Installation](#installation)\n  * [Prerequisites](#prerequisites)\n  * [Two Installation Options](#two-installation-options)\n- [Using the Software](#using-the-software)\n- [Physics and Computer Science Behind the Software](#physics-and-computer-science-behind-the-software)\n- [Contributing](#contributing)\n  * [Code Conventions](#code-conventions)\n  \n## Preliminary Results\n\n![alt text](https://github.com/Samuel-Buteau/universal-battery-database/blob/master/demo_screenshots/capacity_measured_and_modelled.png)\n\n**Figure 1**: Model measurements and make predictions using [`ml_smoothing.py`](https://github.com/Samuel-Buteau/universal-battery-database/wiki/ml_smoothing.py).\n\n## Data Management Software Demo\n\n![alt text](https://github.com/Samuel-Buteau/universal-battery-database/blob/master/demo_screenshots/fix_cycle_example.png)\n\n**Figure 2**: Fix anomologous cycling data using the web browser provided by [`manage.py`](https://github.com/Samuel-Buteau/universal-battery-database/wiki/manage.py).\n\n## Installation\n\n### Prerequisites\n\n- [Python 3](https://www.python.org/downloads/)\n- [pip and virtualenv](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)\n\n### Two Installation Options\n\n1. If you only want to play around with modelling and you have a compiled dataset from somewhere else, you can [install without a database](https://github.com/Samuel-Buteau/universal-battery-database/wiki/Installing-Without-a-Database-(Windows)). This option is simpler and you can always install a database later.\n2. If you want to use the full database features such as parsing and organising experimental data and metadata, you should [install with a database](https://github.com/Samuel-Buteau/universal-battery-database/wiki/Installing-With-a-Database-(Windows)).\n\n\n## Using the Software\n\nUse [`manage.py`](https://github.com/Samuel-Buteau/universal-battery-database/wiki/manage.py) to see the web page and use its analytic features.\n\nUse [`ml_smoothing.py`](https://github.com/Samuel-Buteau/universal-battery-database/wiki/ml_smoothing.py) to use the machine learning model and see the results.\n\n\n## Physics and Computer Science Behind the Software\n\nWe hypothesize that we can make [good generalizations](https://github.com/Samuel-Buteau/universal-battery-database/wiki/Generalization-Criteria) by [approximating](https://github.com/Samuel-Buteau/universal-battery-database/wiki/The-Universal-Approximation-Theorem) the functions that map one degradation mechanism to another using neural networks. \n\nWe aim to develop a theory of lithium-ion cells. We first break down the machine learning problem into smaller sub-problems. From there, we develop frameworks to convert the theory to practical implementations. Finally, we apply the method to experimental data and evaluate the result.\n\n## Contributing\n\n### Code Conventions\n\nGenerally, we follow [Google's Python Style Guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSamuel-Buteau%2Funiversal-battery-database","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSamuel-Buteau%2Funiversal-battery-database","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSamuel-Buteau%2Funiversal-battery-database/lists"}