diff --git a/setup.py b/setup.py index 6944a90..77606c7 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,5 @@ -"""Setup file for bruteforce package.""" +"""Ising: a Python package for exactly solving abritrary Ising model instances using exhaustive search.""" + from setuptools import find_packages # pylint: disable=unused-import from numpy.distutils.core import setup, Extension from numpy.distutils.log import set_verbosity @@ -6,6 +7,9 @@ set_verbosity(1) +with open('README.rst') as readme: + LONG_DESCRIPTION = readme.read() + CPU_SEARCH_EXT = Extension('isingcpu', extra_compile_args=['-fPIC', '-fopenmp', @@ -35,6 +39,8 @@ setup( use_scm_version=True, name='ising', + description=__doc__, + long_description=LONG_DESCRIPTION, cmdclass={'build_ext': BuildExtCommand}, setup_requires=['setuptools_scm'], install_requires=['numpy>=0.16.0', 'psutil', 'progressbar2', 'future'],