From 6d1283656c17c1542138df89bb9d6cd2bcb6de50 Mon Sep 17 00:00:00 2001 From: gphipps Date: Thu, 1 Aug 2024 10:40:52 -0700 Subject: [PATCH] Changing README to use the pypkg standard --- README.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7064c58d..ba47d631 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,25 @@ + +[![license](https://img.shields.io/pypi/l/OneMod)](https://github.com/ihmeuw-msca/OneMod/blob/main/LICENSE) +[![version](https://img.shields.io/pypi/v/OneMod)](https://pypi.org/project/OneMod) +[![build](https://img.shields.io/github/actions/workflow/status/ihmeuw-msca/OneMod/build.yml?branch=main)](https://github.com/ihmeuw-msca/OneMod/actions) +[![docs](https://img.shields.io/badge/docs-here-green)](https://ihmeuw-msca.github.io/OneMod) +[![codecov](https://img.shields.io/codecov/c/github/ihmeuw-msca/OneMod)](https://codecov.io/gh/ihmeuw-msca/OneMod) +[![codacy](https://img.shields.io/codacy/grade/ae72a07785f5469eac234d1f6bdf555f)](https://app.codacy.com/gh/ihmeuw-msca/OneMod/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) + + # OneMod -Currently, the documentation is hosted within -IHME: [https://scicomp-docs.ihme.washington.edu/OneMod/0.2.2/index.html]. -but eventually it will be hosted on readthedocs. -The source for the documentation is in the `docs` directory. +OneMOd is a Python package that provides a framework for building and evaluating +single-parameter models. It is designed to be modular, allowing users to easily +add new models and evaluation metrics. OneMod is built on top of the other +IHME tools. + +OneMod is being actively developed by the Institute for Health Metrics and is +beta software. It is not yet ready for production use. + +For instructions on how to install and use OneMod, please refer to the +[documentation](https://ihmeuw-msca.github.io/OneMod/). + +## License +This project uses the following license: [BSD 2-Clause](./LICENSE)