Add `long_description` to gmxapi package.
authorM. Eric Irrgang <ericirrgang@gmail.com>
Fri, 23 Jul 2021 13:46:19 +0000 (16:46 +0300)
committerM. Eric Irrgang <ericirrgang@gmail.com>
Thu, 5 Aug 2021 15:49:05 +0000 (18:49 +0300)
Ref #4102

python_packaging/src/setup.py

index e53b4227e7c748f5009115ae54a8a5d6bd445efa..254b37302927446a253ca34b612a498b42c4be04 100644 (file)
@@ -157,6 +157,17 @@ cmake_platform_hints = '-DCMAKE_TOOLCHAIN_FILE={}'.format(gmx_toolchain)
 cmake_gmxapi_hint = '-Dgmxapi_ROOT={}'.format(gmxapi_DIR)
 cmake_args = [cmake_platform_hints, cmake_gmxapi_hint]
 
+long_description = """gmxapi provides Python access to GROMACS molecular simulation tools.
+Operations can be connected flexibly to allow high performance simulation and
+analysis with complex control and data flows. Users can define new operations
+in C++ or Python with the same tool kit used to implement this package.
+
+This Python package requires a compatible GROMACS installation with the API
+libraries and headers.
+
+See http://gmxapi.org/ for details on installation and usage.
+"""
+
 setup(
     name='gmxapi',
 
@@ -174,6 +185,7 @@ setup(
     author='M. Eric Irrgang',
     author_email='info@gmxapi.org',
     description='gmxapi Python interface for GROMACS',
+    long_description=long_description,
     license='LGPL',
     url='http://gmxapi.org/',