mischbares

Millimeter Scale High-Throughput Battery Research System

https://github.com/fuzhanrahmanian/mischbares

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

Millimeter Scale High-Throughput Battery Research System

Basic Info
  • Host: GitHub
  • Owner: fuzhanrahmanian
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 3.73 MB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 2
  • Open Issues: 5
  • Releases: 1
Created over 3 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog Contributing License Citation Authors

README.rst

===============
Auto-MISCHBARES
===============

.. image:: https://github.com/fuzhanrahmanian/MISCHBARES/blob/main/logo/mischbares_logo.png?raw=true
    :align: center
    :width: 300px


.. image:: https://zenodo.org/badge/546603657.svg
  :target: https://zenodo.org/doi/10.5281/zenodo.10447746
  :align: center

Overview
--------

Auto-MISCHBARES, building upon our `HELAO framework `_,  is designed for high-throughput electrochemical research. It automates the study of different electrolyte and/or electrode materials, different electrochemical protocols in order to characterize the interphase formations at a millimeter scale, enhancing the efficiency of material discovery. This system's significant feature is its ability to autonomously asynchronously orchestrate sequential or parallel experiments, integrated with advanced Quality Control assessments and `MADAP `_ for advanced data analysis using AI algorithms. The web interface of Auto-MISCHBARES offers streamlined user control, and its database design adheres to FAIR principles, promoting robust and transparent research in battery material science.



Installation
------------

Requirements
~~~~~~~~~~~~

- Python 3.8
- PostgreSQL
- Libraries listed in `requirements.txt`

Installation Steps
~~~~~~~~~~~~~~~~~~

1. Clone the repository::

     git clone https://github.com/fuzhanrahmanian/MISCHBARES.git

2. Navigate to the directory::

     cd MISCHBARES

3. Install the required libraries::

     pip install -r requirements.txt

Starting the Application
------------------------

Run the application::

    python app.py

Database Setup
--------------

1. Navigate to the `db` directory::

     cd db

2. Initialize the PostgreSQL database using the schema file::

     psql -U [username] -d [database_name] -a -f mischbares_db.sql

Replace `[username]` and `[database_name]` with your PostgreSQL credentials.


Information
-----------

Tutorial and demonstration can be find at ``_.

The data related to this study is available at ``_.

Cite this work
--------------

If you use this software in your research, please cite the following paper: `preprint `_



For more detailed information, please visit the `documentation page `_

Owner

  • Name: Fuzhan R
  • Login: fuzhanrahmanian
  • Kind: user
  • Location: Neu-Ulm, Germany
  • Company: Karlsruhe University (KIT)

GitHub Events

Total
  • Fork event: 1
Last Year
  • Fork event: 1

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 170
  • Total Committers: 1
  • Avg Commits per committer: 170.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Fuzhan R f****n@g****m 170

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 6
  • Total pull requests: 10
  • Average time to close issues: 2 days
  • Average time to close pull requests: 1 minute
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • fuzhanrahmanian (6)
Pull Request Authors
  • fuzhanrahmanian (10)
Top Labels
Issue Labels
enhancement (5) question (1)
Pull Request Labels

Dependencies

.github/workflows/documentation.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • peaceiris/actions-gh-pages v3 composite
requirements.txt pypi
  • Sphinx *
  • bump2version ==0.5.11
  • coverage ==4.5.4
  • fastapi *
  • flake8 ==3.7.8
  • numpy *
  • pip ==19.2.3
  • pytest ==6.2.4
  • pythonnet ==2.5.1
  • tox ==3.14.0
  • twine ==1.14.0
  • uvicorn *
  • watchdog ==0.9.0
  • wheel ==0.33.6
setup.py pypi