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.

Sign up for GitHub

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

Jump to bottom

DOC: add badges. #53

Merged
merged 1 commit into from
Sep 21, 2023
Merged

DOC: add badges. #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
WorkFlow for Automated Cluster Expansion Regression (WFacer)
===================================================

*Modulated automation of cluster expansion model construction based on atomate2 and Jobflow*
*Modulated automation of cluster expansion model fitting based on atomate2 and Jobflow*

-----------------------------------------------------------------------------
[![test](https://github.com/CederGroupHub/WFacer/actions/workflows/test.yml/badge.svg)](https://github.com/CederGroupHub/WFacer/actions/workflows/test.yml)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/3385a15764b144589ef993b942b2a159)](https://app.codacy.com/gh/CederGroupHub/WFacer/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/3385a15764b144589ef993b942b2a159)](https://app.codacy.com/gh/CederGroupHub/WFacer/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/CederGroupHub/WFacer/main.svg)](https://results.pre-commit.ci/latest/github/CederGroupHub/WFacer/main)
[![pypi version](https://img.shields.io/pypi/v/WFacer?color=blue)](https://pypi.org/project/WFacer)
[![Static Badge](https://img.shields.io/badge/python-3.8%2B-blue)](https://www.python.org/downloads/)

**WFacer** ("Wall"Facer) is a light-weight package based on [smol](https://github.com/CederGroupHub/smol.git)
to automate the fitting of lattice models in disordered crystalline solids using
Expand Down
23 changes: 22 additions & 1 deletion docs/src/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,31 @@
WorkFlow for Automated Cluster Expansion Regression (WFacer)
============================================================

*Modulated automation of cluster expansion model construction based on atomate2 and Jobflow*
*Modulated automation of cluster expansion model fitting based on atomate2 and Jobflow*

**************

.. |test| image:: https://github.com/CederGroupHub/WFacer/actions/workflows/test.yml/badge.svg
:target: https://github.com/CederGroupHub/WFacer/actions/workflows/test.yml

.. |codacy_grade| image:: https://app.codacy.com/project/badge/Grade/3385a15764b144589ef993b942b2a159
:target: https://app.codacy.com/gh/CederGroupHub/WFacer/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade

.. |codacy_coverage| image:: https://app.codacy.com/project/badge/Coverage/3385a15764b144589ef993b942b2a159
:target: https://app.codacy.com/gh/CederGroupHub/WFacer/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage

.. |precommit| image:: https://results.pre-commit.ci/badge/github/CederGroupHub/WFacer/main.svg
:target: https://results.pre-commit.ci/latest/github/CederGroupHub/WFacer/main

.. |pypi_version| image:: https://img.shields.io/pypi/v/WFacer?color=blue
:target: https://pypi.org/project/WFacer

.. |static_badge| image:: https://img.shields.io/badge/python-3.8%2B-blue
:target: https://www.python.org/downloads/

|test| |codacy_grade| |codacy_coverage| |precommit| |pypi_version| |static_badge|


WFacer ("Wall"Facer) is a light-weight package based on `smol <https://github.com/CederGroupHub/smol.git>`_
to automate the fitting of lattice models in disordered crystalline solids using
*cluster expansion* method. Beyond metallic alloys, **WFacer** is also designed
Expand Down