python_packaging/src/setup.py

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
   5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6 # and including many others, as listed in the AUTHORS file in the
   7 # top-level source directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 # Python setuptools script to build and install the gmxapi Python interface
  36 # from a GROMACS installation directory.
  37
  38 # Usage note: things go smoothly when we stick to the setup.py convention of
  39 # having a package source directory with the same name as the package at the
  40 # same level as the setup.py script and only expect `pip install .` in the
  41 # setup.py directory. If we play with the layout more, it is hard to keep all
  42 # of the `pip` and `setup.py` cases working as expected. This is annoying
  43 # because running the Python interpreter immediately from the same directory
  44 # can find the uninstalled source instead of the installed package. We can
  45 # ease this pain by building an sdist in the enclosing CMake build scope
  46 # and encouraging users to `pip install the_sdist.archive`. Otherwise, we
  47 # just have to document that we only support full build-install of the Python
  48 # package from the directory containing setup.py, which may clutter that
  49 # directory with some artifacts.
  50
  51 import os
  52
  53 # Import setuptools early to avoid UserWarning from Distutils.
  54 # Ref: https://gitlab.com/gromacs/gromacs/-/issues/3715
  55 import setuptools
  56
  57 # Allow setup.py to be run when scikit-build is not installed, such as to
  58 # produce source distribution archives with `python setup.py sdist`
  59 try:
  60     from skbuild import setup
  61 except ImportError:
  62     from distutils.core import setup
  63
  64 usage = """
  65 The `gmxapi` package requires an existing GROMACS installation, version 2020 or higher.
  66 To specify the GROMACS installation to use, provide a GMXTOOLCHAINDIR
  67 environment variable when running setup.py or `pip`.
  68
  69 Example:
  70     GMXTOOLCHAINDIR=/path/to/gromacs/share/cmake/gromacs pip install gmxapi
  71
  72 If you have multiple builds of GROMACS, distinguished by a suffix `$SUFFIX`, the
  73 tool chain directory will use that suffix.
  74
  75 Example:
  76     GMXTOOLCHAINDIR=/path/to/gromacs/share/cmake/gromacs$SUFFIX pip install gmxapi
  77
  78 In the example, `gmxapi` is downloaded automatically from pypi.org. You can
  79 replace `gmxapi` with a local directory or archive file to build from a source
  80 distribution.
  81
  82 setup.py will use the location of GMXTOOLCHAINDIR to locate the
  83 gmxapi library configured during GROMACS installation. Alternatively, if
  84 gmxapi_DIR is provided, or if GMXRC has been "sourced", the toolchain file
  85 location may be deduced. Note, though, that if multiple GROMACS installations
  86 exist in the same location (with different suffixes) only the first one will be
  87 used when guessing a toolchain, because setup.py does not know which corresponds
  88 to the gmxapi support library.
  89
  90 If specifying GMXTOOLCHAINDIR and gmxapi_DIR, the tool chain directory must be
  91 located within a subdirectory of gmxapi_DIR.
  92
  93 Refer to project web site for complete documentation.
  94
  95 """
  96
  97
  98 class GmxapiInstallError(Exception):
  99     """Error processing setup.py for gmxapi Python package."""
 100
 101
 102 gmx_toolchain_dir = os.getenv('GMXTOOLCHAINDIR')
 103 gmxapi_DIR = os.getenv('gmxapi_DIR')
 104 if gmxapi_DIR is None:
 105     # Infer from GMXRC exports, if available.
 106     gmxapi_DIR = os.getenv('GROMACS_DIR')
 107
 108
 109 def _find_first_gromacs_suffix(directory):
 110     dir_contents = os.listdir(directory)
 111     for entry in dir_contents:
 112         if entry.startswith('gromacs'):
 113             return entry.strip('gromacs')
 114
 115
 116 if gmx_toolchain_dir is None:
 117     # Try to guess from standard GMXRC environment variables.
 118     if gmxapi_DIR is not None:
 119         if os.path.exists(gmxapi_DIR) and os.path.isdir(gmxapi_DIR):
 120             share_cmake = os.path.join(gmxapi_DIR, 'share', 'cmake')
 121             suffix = _find_first_gromacs_suffix(share_cmake)
 122             if suffix is not None:
 123                 gmx_toolchain_dir = os.path.join(share_cmake, 'gromacs' + suffix)
 124
 125 if gmx_toolchain_dir is None:
 126     print(usage)
 127     raise GmxapiInstallError('Could not configure for GROMACS installation. Provide GMXTOOLCHAINDIR.')
 128
 129 suffix = os.path.basename(gmx_toolchain_dir).strip('gromacs')
 130 gmx_toolchain = os.path.abspath(os.path.join(gmx_toolchain_dir, 'gromacs-toolchain' + suffix + '.cmake'))
 131
 132 if gmxapi_DIR is None:
 133     # Example: given /usr/local/gromacs/share/cmake/gromacs/gromacs-toolchain.cmake,
 134     # we would want /usr/local/gromacs.
 135     # Note that we could point more directly to the gmxapi-config.cmake but,
 136     # so far, we have relied on CMake automatically looking into
 137     # <package>_DIR/share/cmake/<package>/ for such a file.
 138     # We would need a slightly different behavior for packages that link against
 139     # libgromacs directly, as sample_restraint currently does.
 140     gmxapi_DIR = os.path.join(os.path.dirname(gmx_toolchain), '..', '..', '..')
 141
 142 gmxapi_DIR = os.path.abspath(gmxapi_DIR)
 143
 144 if not os.path.exists(gmxapi_DIR) or not os.path.isdir(gmxapi_DIR):
 145     print(usage)
 146     raise GmxapiInstallError('Please set a valid gmxapi_DIR.')
 147
 148 if gmxapi_DIR != os.path.commonpath([gmxapi_DIR, gmx_toolchain]):
 149     raise GmxapiInstallError('GROMACS toolchain file {} is not in gmxapi_DIR {}'.format(
 150         gmx_toolchain,
 151         gmxapi_DIR
 152     ))
 153
 154 cmake_platform_hints = '-DCMAKE_TOOLCHAIN_FILE={}'.format(gmx_toolchain)
 155 # Note that <package>_ROOT is not standard until CMake 3.12
 156 # Reference https://cmake.org/cmake/help/latest/policy/CMP0074.html#policy:CMP0074
 157 cmake_gmxapi_hint = '-Dgmxapi_ROOT={}'.format(gmxapi_DIR)
 158 cmake_args = [cmake_platform_hints, cmake_gmxapi_hint]
 159
 160 setup(
 161     name='gmxapi',
 162
 163     # TODO: single-source version information (currently repeated in gmxapi/version.py and CMakeLists.txt)
 164     version='0.3.0a2',
 165     python_requires='>=3.7',
 166     install_requires=['networkx>=2.0',
 167                       'numpy>=1'],
 168
 169     packages=['gmxapi', 'gmxapi.simulation'],
 170     package_data={'gmxapi': ['gmxconfig.json']},
 171
 172     cmake_args=cmake_args,
 173
 174     author='M. Eric Irrgang',
 175     author_email='info@gmxapi.org',
 176     description='gmxapi Python interface for GROMACS',
 177     license='LGPL',
 178     url='http://gmxapi.org/',
 179
 180     # The installed package will contain compiled C++ extensions that cannot be loaded
 181     # directly from a zip file.
 182     zip_safe=False
 183 )