setup.py 11.5 KB
Newer Older
eric pellegrini's avatar
eric pellegrini committed
1 2 3
import fnmatch
import glob
import os
4
import subprocess
eric pellegrini's avatar
eric pellegrini committed
5 6 7 8
import sys

import numpy

eric pellegrini's avatar
eric pellegrini committed
9
from Cython.Distutils import build_ext as cython_build_ext
eric pellegrini's avatar
eric pellegrini committed
10 11

from distutils.command.build import build
eric pellegrini's avatar
eric pellegrini committed
12
from distutils.core import setup, Extension
eric pellegrini's avatar
eric pellegrini committed
13 14 15
from distutils.sysconfig import get_config_vars
from distutils.util import convert_path

eric pellegrini's avatar
eric pellegrini committed
16 17 18 19 20 21 22 23 24 25
try:
    import sphinx
except ImportError:
    sphinx = None

try:
    import stdeb
except ImportError:
    stdeb = None

eric pellegrini's avatar
eric pellegrini committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
#################################
# Modules variables
#################################
EXCLUDE = ['*.py', '*.pyc', '*$py.class', '*~', '.*', '*.bak', '*.so', '*.pyd']

EXCLUDE_DIRECTORIES = ('.*', 'CVS', '_darcs', './build','*svn','./dist', 'EGG-INFO', '*.egg-info')

EXTENSIONS_PATH = "Extensions"

INCLUDE_DIR = [numpy.get_include()]

QHULL_DIR = os.path.join("Extensions","qhull_lib")

QHULL_INCLUDE_DIR = INCLUDE_DIR + [EXTENSIONS_PATH] + [os.path.join(QHULL_DIR,"ext")] + [os.path.join(QHULL_DIR,"src")]

#################################
# Helper function
#################################

def is_package(path):
    return (os.path.isdir(path) and os.path.isfile(os.path.join(path, '__init__.py')))

def find_packages(path, base="", exclude=None):

    packages = {}

    for item in os.listdir(path):
        d = os.path.join(path, item)
        if exclude is not None and (os.path.abspath(d) == os.path.abspath(exclude)):
            continue
        if is_package(d):
            if base:
                module_name = "%(base)s.%(item)s" % vars()
            else:
                module_name = item
            packages[module_name] = d
            packages.update(find_packages(d, module_name, exclude))
            
    return packages

def find_package_data(where='.', package='', exclude=EXCLUDE, exclude_directories=EXCLUDE_DIRECTORIES, only_in_packages=True, show_ignored=False):
    
    out = {}
    stack = [(convert_path(where), '', package, only_in_packages)]
    while stack:
        where, prefix, package, only_in_packages = stack.pop(0)
        for name in os.listdir(where):
            fn = os.path.join(where, name)
            if os.path.isdir(fn):
                bad_name = False
                for pattern in exclude_directories:
                    if (fnmatch.fnmatchcase(name, pattern)
                        or fn.lower() == pattern.lower()):
                        bad_name = True
                        if show_ignored:
                            print >> sys.stderr, ("Directory %s ignored by pattern %s" % (fn, pattern))
                        break
                if bad_name:
                    continue
                if (os.path.isfile(os.path.join(fn, '__init__.py')) and not prefix):
                    if not package:
                        new_package = name
                    else:
                        new_package = package + '.' + name
                    stack.append((fn, '', new_package, False))
                else:
                    stack.append((fn, prefix + name + '/', package, only_in_packages))
            elif package or not only_in_packages:
                # is a file
                bad_name = False
                for pattern in exclude:
                    if (fnmatch.fnmatchcase(name, pattern)
                        or fn.lower() == pattern.lower()):
                        bad_name = True
                        if show_ignored:
                            print >> sys.stderr, ("File %s ignored by pattern %s" % (fn, pattern))
                        break
                if bad_name:
                    continue
                out.setdefault(package, []).append(prefix+name)
    
    return out


def find_data(where=".", exclude=EXCLUDE, exclude_directories=EXCLUDE_DIRECTORIES, prefix=""):

    out = {}
    stack = [convert_path(where)]
    while stack:
        where = stack.pop(0)
        for name in os.listdir(where):
            fn = os.path.join(where, name)
            d = os.path.join(prefix,os.path.dirname(fn))
            if os.path.isdir(fn):
                stack.append(fn)
            else:
                bad_name = False
                for pattern in exclude:
                    if (fnmatch.fnmatchcase(name, pattern) or fn.lower() == pattern.lower()):
                        bad_name = True
                        break
                if bad_name:
                    continue
                out.setdefault(d, []).append(fn)
            
    out = [(k,v) for k, v in out.items()]
    
    return out


#################################
# Packages section
#################################

PACKAGE_INFO = {}
eric pellegrini's avatar
eric pellegrini committed
141
execfile('MDANSE/__pkginfo__.py', {}, PACKAGE_INFO)
eric pellegrini's avatar
eric pellegrini committed
142

eric pellegrini's avatar
eric pellegrini committed
143
PACKAGES = find_packages(path=".")
eric pellegrini's avatar
eric pellegrini committed
144 145 146 147 148 149
PACKAGES = PACKAGES.keys()

#################################
# Package data section
#################################

150 151
# Retrieve all the data related to the MDANSE package.
PACKAGE_DATA = find_package_data(where='MDANSE', package='MDANSE', show_ignored=False)
eric pellegrini's avatar
eric pellegrini committed
152 153 154 155 156 157

#################################
# User data section
#################################

DATA_FILES = []
eric pellegrini's avatar
eric pellegrini committed
158
DATA_FILES.extend(find_data('Doc',exclude=[],prefix='conf_'))
eric pellegrini's avatar
eric pellegrini committed
159 160 161 162 163

#################################
# Scripts section
#################################

164 165
SCRIPTS_PATH = "Scripts"
SCRIPTS = glob.glob(os.path.join(SCRIPTS_PATH,'mdanse*'))
eric pellegrini's avatar
eric pellegrini committed
166

167 168 169 170
#################################
# Documentation
#################################

eric pellegrini's avatar
eric pellegrini committed
171
if sphinx:
172

173
    import sphinx.setup_command
eric pellegrini's avatar
eric pellegrini committed
174 175 176 177 178 179

    try:
        from sphinx.ext.apidoc import main as sphinx_apidoc_main
    except ImportError:
        from sphinx.apidoc import main as sphinx_apidoc_main

eric pellegrini's avatar
eric pellegrini committed
180
    class mdanse_build_doc(sphinx.setup_command.BuildDoc):
181

eric pellegrini's avatar
eric pellegrini committed
182 183 184 185 186
        def run(self):
            
            build = self.get_finalized_command('build')
                    
            buildDir = os.path.abspath(build.build_lib)
187

188 189 190
            if not os.path.exists(buildDir):
                raise IOError("build command must be performed prior building the doc")

eric pellegrini's avatar
eric pellegrini committed
191
            sys.path.insert(0,buildDir)
192

193 194 195 196
            sphinxDir = os.path.abspath(os.path.join(build.build_base,'sphinx',self.doctype))

            if not os.path.exists(sphinxDir):
                os.mkdir(sphinxDir)
eric pellegrini's avatar
eric pellegrini committed
197 198
                                 
            metadata = self.distribution.metadata
eric pellegrini's avatar
eric pellegrini committed
199
            args = ["-F",
200 201 202 203 204 205 206 207
                    "--separate",
                    "-H%s" % metadata.name,
                    "-A%s" % metadata.author,
                    "-R%s" % metadata.version,
                    "-o%s" % sphinxDir,
                    os.path.join(buildDir,'MDANSE'),
                    os.path.join(buildDir,'MDANSE','Externals')]

eric pellegrini's avatar
eric pellegrini committed
208 209 210 211 212 213

            # /!\ apidoc.main is deprecated. The API has been broken in sphinx 1.7.0, see https://github.com/sphinx-doc/sphinx/issues/4615
            if int(sphinx.__version__.split(".")[1]) <= 6:
                args.insert(0,"")

            sphinx_apidoc_main(args)
214 215
                             
            currentDirectory = os.getcwd()
216
            
eric pellegrini's avatar
eric pellegrini committed
217
            import shutil
218 219 220
            shutil.copy(os.path.join(currentDirectory,'Doc','conf_%s.py' % self.doctype),os.path.join(sphinxDir,'conf.py'))
            shutil.copy(os.path.join(currentDirectory,'Doc','mdanse_logo.png'),os.path.join(sphinxDir,'_static'))
            shutil.copy(os.path.join(currentDirectory,'Doc','layout.html'),os.path.join(sphinxDir,'_templates'))
eric pellegrini's avatar
eric pellegrini committed
221 222 223 224 225 226 227 228 229
     
            # The directory where the rst files are located.
            self.source_dir = sphinxDir
            # The directory where the conf.py file is located.
            self.config_dir = self.source_dir
     
            # The directory where the documentation will be built
            self.build_dir = os.path.join(buildDir,'MDANSE','Doc',self.doctype)
            
eric pellegrini's avatar
eric pellegrini committed
230 231 232 233 234 235 236 237
            if isinstance(self.builder,basestring):
                builders = [self.builder]
            else:
                builders = self.builder

            for builder in builders:
                self.builder_target_dir = os.path.join(self.build_dir, builder)
                sphinx.setup_command.BuildDoc.run(self)
eric pellegrini's avatar
eric pellegrini committed
238 239 240 241
                 
            sys.path.pop(0)
            
    class mdanse_build_help(mdanse_build_doc):
242
        
eric pellegrini's avatar
eric pellegrini committed
243
        doctype = 'help'
244

eric pellegrini's avatar
eric pellegrini committed
245
    class mdanse_build_api(mdanse_build_doc):
246
        
eric pellegrini's avatar
eric pellegrini committed
247 248
        doctype = 'api'
                        
eric pellegrini's avatar
eric pellegrini committed
249 250 251 252 253 254 255 256
#################################
# Extensions section
#################################

if 'linux' in sys.platform:
    (opt,) = get_config_vars('OPT')
    os.environ['OPT'] = " ".join(flag for flag in opt.split() if flag != '-Wstrict-prototypes')

257
EXTENSIONS = [Extension('MDANSE.Extensions.distance_histogram',
eric pellegrini's avatar
eric pellegrini committed
258 259
                        include_dirs=INCLUDE_DIR,
                        sources = [os.path.join("Extensions",'distance_histogram.pyx')]),
260
              Extension('MDANSE.Extensions.fast_calculation',
eric pellegrini's avatar
eric pellegrini committed
261 262
                        include_dirs=INCLUDE_DIR,
                        sources = [os.path.join("Extensions",'fast_calculation.pyx')]),
263
              Extension('MDANSE.Extensions.sas_fast_calc',
eric pellegrini's avatar
eric pellegrini committed
264 265
                        include_dirs=INCLUDE_DIR,
                        sources = [os.path.join("Extensions",'sas_fast_calc.pyx')]),
266
              Extension('MDANSE.Extensions.mt_fast_calc',
eric pellegrini's avatar
eric pellegrini committed
267 268
                        include_dirs=INCLUDE_DIR,
                        sources = [os.path.join("Extensions",'mt_fast_calc.pyx')]),
269
              Extension('MDANSE.Extensions.sd_fast_calc',
eric pellegrini's avatar
eric pellegrini committed
270 271
                        include_dirs=INCLUDE_DIR,
                        sources = [os.path.join("Extensions",'sd_fast_calc.pyx')]),
272
              Extension('MDANSE.Extensions.mic_fast_calc', 
eric pellegrini's avatar
eric pellegrini committed
273 274 275
                        include_dirs=INCLUDE_DIR,
                        sources = [os.path.join("Extensions",'mic_fast_calc.pyx')],
                        language="c++"),
276
              Extension('MDANSE.Extensions.qhull',
eric pellegrini's avatar
eric pellegrini committed
277 278
                        include_dirs  = QHULL_INCLUDE_DIR,
                        sources =  glob.glob(os.path.join(QHULL_DIR, 'src','*.c')) + [os.path.join("Extensions",'qhull.pyx')],
279 280
                        define_macros = [('qh_QHpointer','1')]),
              Extension('MDANSE.Extensions.xtc',
281
                        include_dirs=[numpy.get_include(),os.path.join('Extensions','xtc','include')],
282
                        sources=glob.glob(os.path.join('Extensions','xtc','src','*.c')) + [os.path.join('Extensions','xtc','xtc.pyx')])
eric pellegrini's avatar
eric pellegrini committed
283 284
              ]

285
CMDCLASS = {'build_ext' : cython_build_ext}
eric pellegrini's avatar
eric pellegrini committed
286

eric pellegrini's avatar
eric pellegrini committed
287 288 289
if sphinx:
    CMDCLASS['build_api'] = mdanse_build_api
    CMDCLASS['build_help'] = mdanse_build_help
eric pellegrini's avatar
eric pellegrini committed
290 291 292 293 294
             
#################################
# The setup section
#################################

295
setup (name             = "MDANSE",
eric pellegrini's avatar
eric pellegrini committed
296
       version          = PACKAGE_INFO["__version__"],
eric pellegrini's avatar
eric pellegrini committed
297 298 299 300 301 302 303 304
       description      = PACKAGE_INFO["__description__"],
       long_description = PACKAGE_INFO["__long_description__"],
       author           = PACKAGE_INFO["__author__"],
       author_email     = PACKAGE_INFO["__author_email__"],
       maintainer       = PACKAGE_INFO["__maintainer__"],
       maintainer_email = PACKAGE_INFO["__maintainer_email__"],
       url              = PACKAGE_INFO["__url__"],
       license          = PACKAGE_INFO["__license__"],
eric pellegrini's avatar
eric pellegrini committed
305 306 307 308 309 310
       packages         = PACKAGES,
       package_data     = PACKAGE_DATA,
       data_files       = DATA_FILES,
       platforms        = ['Unix','Windows'],
       ext_modules      = EXTENSIONS,
       scripts          = SCRIPTS,
311
       cmdclass         = CMDCLASS,
eric pellegrini's avatar
eric pellegrini committed
312
       install_requires = ['Jinja2'])