diff --git a/README.md b/README.md index b8ed9f8..777d225 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ [![GitHub version](https://badge.fury.io/gh/ecrl%2FGraphChem.svg)](https://badge.fury.io/gh/ecrl%2FGraphChem) [![PyPI version](https://badge.fury.io/py/graphchem.svg)](https://badge.fury.io/py/graphchem) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/ecrl/GraphChem/master/LICENSE.txt) +[![Documentation Status](https://readthedocs.org/projects/graphchem/badge/?version=latest)](https://graphchem.readthedocs.io/en/latest/?badge=latest) +[![Build Status](https://dev.azure.com/uml-ecrl/package-management/_apis/build/status%2Fecrl.graphchem?branchName=master)](https://dev.azure.com/uml-ecrl/package-management/_build/latest?definitionId=6&branchName=master) **GraphChem** is an open source Python package for constructing graph-based machine learning models with a focus on fuel property prediction. diff --git a/docs/index.md b/docs/index.md index eca1037..9558e9e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@ -# GraphChem Documentation - [![UML Energy & Combustion Research Laboratory](https://sites.uml.edu/hunter-mack/files/2021/11/ECRL_final.png)](http://faculty.uml.edu/Hunter_Mack/) +# GraphChem Documentation + [![GitHub version](https://badge.fury.io/gh/ecrl%2FGraphChem.svg)](https://badge.fury.io/gh/ecrl%2FGraphChem) [![PyPI version](https://badge.fury.io/py/graphchem.svg)](https://badge.fury.io/py/graphchem) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/ecrl/GraphChem/master/LICENSE.txt) @@ -35,6 +35,10 @@ $ python setup.py install If any errors occur when installing dependencies, namely with RDKit, PyTorch, or torch-geometric, visit their installation pages and follow the installation instructions: [RDKit](https://www.rdkit.org/docs/Install.html), [PyTorch](https://pytorch.org/get-started/locally/), [PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/notes/installation.html) +# Usage: + +For advanced usage, head over to our [API documentation page](https://graphchem.readthedocs.io/en/latest/). + # Examples To view some examples of how GraphChem can be used, head over to our [examples](https://github.com/ecrl/graphchem/tree/master/examples) folder on GitHub. @@ -45,4 +49,4 @@ To contribute to GraphChem, make a pull request. Contributions should include te To report problems with the software or feature requests, file an issue. When reporting problems, include information such as error messages, your OS/environment and Python version. -For additional support/questions, contact Travis Kessler (Travis_Kessler@student.uml.edu). \ No newline at end of file +For additional support/questions, contact Travis Kessler (Travis_Kessler@student.uml.edu).