Welcome!

If you work with battery data in any capacity, you have come to the right place. In this repo, you can find worked examples and how-to guides on how to get started with the AmpLabs Toolkit. As AmpLabs is an Open Source project, we are powered by contributions from the community. There are many ways to participate in the community development process. All contributions are welcome, feel free to start today!

If you would like to learn more about the background of our community project, please check out the AmpLabs Documentation

Contribution Checklist

1. Star this GitHub repo
2. Read through AmpLabs Documentation
3. If you would like to propose a change, please do so on the corresponding repo. Please submit change requests to this repo on AmpLabs GitHub Issue
4. Any open ended questions or general comments can be added to AmpLabs GitHub Discussions.
5. Try the AmpLabs Python Examples
6. Check out AmpLabs Cloud Service to see a managed version of the application running on AWS
7. If you are interested in developing the software for the AmpLabs Cloud Service, please visit AmpLabs Cloud Service GitHub Repo
8. Attend Open Meetings
9. Share your experience on LinkedIn!

If you are interested in contributing changes today, a list of current To Do Items can be found on GitHub Issues. (Issues are tasks that need to be completed).

1. Assign a GitHub Issue to yourself that you are comfortable with completing.
2. Fork the repo and/or create a new branch
3. Make the required changes. If anything in the Issue is unclear, please comment on the Issue directly
4. Submit a Pull Request (PR) against the main branch
5. Await Review from a Maintainer.

Cheers!

Note: Feel free to @ mention users as AmpLabs development is largely asynchronous and includes people across multiple timezones, this is a great way to get people's attention onto new or pressing items.