setup.py

#!/usr/bin/env python3
# -*- coding: utf-8; fill-column: 100; truncate-lines: t -*-
#
# This file is part of CMInject
#
# Copyright (C) 2018,2020 CFEL Controlled Molecule Imaging group
#
# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
# later version.
#
# If you use this program for scientific work, you should correctly reference it; see the LICENSE.md file for details.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with this program. If not, see
# <http://www.gnu.org/licenses/>.

import sys
from setuptools import setup, find_packages, Extension, dist

# https://luminousmen.com/post/resolve-cython-and-numpy-dependencies
cython_numpy = ['Cython<0.29.21,>0.29.0', 'numpy~=1.19.0']
dist.Distribution().fetch_build_eggs(cython_numpy)
from Cython.Build import cythonize
import numpy

name = 'cminject'
version = '1.0.8'
release = version
author = 'Simon Welker, Muhamed Amin, and the CFEL Controlled Molecule Imaging group'
copyright = f'2021, {author}'
description = 'A Python framework for defining and executing particle trajectory simulations for sample injection.'

curr_maintainer_name = 'Simon Welker'
curr_maintainer_email = 'simon.welker@cfel.de'

long_description = f"""
CMInject -- {description}.

Developed by {author} at the Center for Free-Electron Laser Science, Deutsches Elektronen-Synchrotron DESY and
Universität Hamburg, Hamburg, Germany.

Original author:    Muhamed Amin <muhamed.amin@cfel.de> and the CMI COMOTION team
Current maintainer: {curr_maintainer_name} <{curr_maintainer_email}> and the Controlled Molecule Imaging group
"""

if sys.version_info < (3, 6):
    sys.exit('Sorry, Python < 3.6 is not supported')

package_dir = {'': 'lib'}
packages = find_packages(where='lib')

scripts = [
    'bin/cminject',
    'bin/cminject_txt-to-hdf5',
    'bin/cminject_visualize',
    'bin/cminject_analyze-asymmetry',
    'bin/cminject_analyze-beam'
]

install_requires = cython_numpy + [
    'scipy~=1.5.0',
    'numba~=0.53.1',
    'pandas~=1.0.5',
    'matplotlib~=3.3.4',
    'h5py~=3.3.0',
    'Sphinx~=3.4.3',
    'docutils<0.16',  # see e.g. https://github.com/matplotlib/matplotlib/pull/16358
    'sphinx_rtd_theme~=0.5.1',
    'tqdm~=4.56.0',
]

extensions = [
    Extension('cminject.utils.cython_interpolation',
              ['lib/cminject/utils/cython_interpolation.pyx'],
              include_dirs=[numpy.get_include(), '.'])
]

classifiers = [
    'Development Status :: 5 - Production/Stable',
    'Environment :: Console',
    'Intended Audience :: Science/Research',
    'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
    'Operating System :: MacOS :: MacOS X',
    'Operating System :: Microsoft :: Windows',
    'Operating System :: POSIX',
    'Operating System :: POSIX :: Linux',
    'Operating System :: Unix',
    'Operating System :: OS Independent',
    'Programming Language :: Python',
    'Programming Language :: Python :: 3 :: Only',
    'Programming Language :: Python :: 3.6',
    'Programming Language :: Python :: 3.7',
    'Programming Language :: Python :: 3.8',
    'Topic :: Scientific/Engineering',
    'Topic :: Software Development :: Libraries',
]

build_sphinx_options = {
    'project': ('setup.py', name),
    'version': ('setup.py', version),
    'release': ('setup.py', release),
    'source_dir': ('setup.py', 'doc'),
    'copyright': ('setup.py', copyright)
}

setup(name=name,
      version=release,
      description=description,
      long_description=long_description,
      author=author,
      author_email=curr_maintainer_email,
      maintainer='CFEL Controlled Molecule Imaging group',
      maintainer_email='cminject@desy.de',  # need to set up an email list with that name ;-)
      url='https://github.com/CFEL-CMI/cminject',  # put on github and adjust
      package_dir=package_dir,
      packages=packages,
      scripts=scripts,
      python_requires='>=3.6',
      install_requires=install_requires,
      setup_requires=['pytest-runner~=5.3.0'],
      tests_require=['pytest~=6.2.3'],
      ext_modules=cythonize(extensions),
      command_options={'build_sphinx': build_sphinx_options},
      classifiers=classifiers
)