python_packaging/CMakeLists.txt

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2019, 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 # Stub file for future higher-level CMake management. Ultimately, we want to
  36 # drive building and testing from the repository-level CMake configuration, but
  37 # in the initial packaging, tests are somewhat manual and installation of the
  38 # Python package is driven through the setup.py file in src.
  39 #
  40 # To be driven by a higher-level CMake configuration, a CMakeLists.txt file at this level would
  41 # 1. configure: copy the contents of `src` to the build directory, potentially
  42 #    configuring version info and CMakeToolchain for GROMACS
  43 # 2. build: run (cd $CMAKE_CURRENT_BINARY_DIR/src && python setup.py sdist),
  44 #    producing $CMAKE_CURRENT_BINARY_DIR/src/dist/gmxapi-0.1.0.dev0+fr7.tar.gz or similar
  45 #    (add_custom_command(OUTPUT $sdist_name ...) where sdist_name is determined with
  46 #    `python setup.py --full-name` and a choice of argument for `python setup.py sdist --formats`
  47 # 3. install: copy the source distribution to $GROMACS_INSTALL_DIR/sdist/ or something
  48 # 4. test:
  49 #    0. copy src/test
  50 #    1. require GROMACS library target to be present or importable
  51 #    2. create and activate a Python venv in the build dir
  52 #    3. `pip install <the_sdist_archive_file>` into the venv
  53 #    4. run `pytest copy_of_src/test`