Welcome to FAIR-Battery docs

In the FAIR-Battery FAIR-Battery project, we aim to create an open-source electrochemical battery (FAIR = Findable + Accessible + Interoperable + Reproducible).

FAIR-Battery is meant to be:

• Open-source: all designs and data that is useful for further development will be shared

• Scalable: both small and medium scale installations are supported and considered in new designs

• Versatile: alternative chemistries or material resources will be accommodated as much as possible

You can find the code of this package on Github. The documentation is hosted on Read The Docs.

Further in the docs:

• Introduction to FAIR-Battery
  • FAIR-Battery strategic choices
  • Where to start?
  • How the name was chosen
  • Glossary of Terms
• Unboxing the FAIR-Battery [WIP]
  • Getting started
• How to Install
  • Requirements
  • Installation from source
  • Getting started
• FAIR-Battery 101
  • For Mac
  • For Windows
• Technical Drawings
  • Battery Charging Circuit
  • Battery Discharging Circuit
• Materials Database [WIP]
  • How to Submit
• Testing a Unit [WIP]
  • Important metrics when measuring batteries:
• Troubleshooting
  • Hardware Troubleshooting
  • Software Troubleshooting
    • ImportError: No module named ‘Battery_Testing_Software’
    • FileNotFoundError: Could not find module ‘dwf’ (or one of its dependencies)
    • Error: AD2 Device not connected
• Customization
  • Software Structure
    • Controller
    • Model
    • View
    • Resources
• How to contribute
  • Adding examples

Acknowledgement

• labphew - this project is a fork of labphew

If you know of a package that should be added to this list, please do not hesitate to drop us a message.