source: sasview/setup.py @ 47d93073

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.2.2ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 47d93073 was b854587, checked in by GitHub <noreply@…>, 8 years ago

Merge branch 'master' into pytest
  • Property mode set to 100755
File size: 15.0 KB
Line 
1# -*- coding: utf-8 -*-
2#!/usr/bin/env python
3
4"""
5    Setup for SasView
6    TODO: Add checks to see that all the dependencies are on the system
7"""
8
9import os
10import subprocess
11import shutil
12import sys
13from distutils.command.build_ext import build_ext
14from distutils.core import Command
15
16import numpy as np
17from setuptools import Extension, setup
18
19# Manage version number ######################################
20import sasview
21
22VERSION = sasview.__version__
23##############################################################
24
25package_dir = {}
26package_data = {}
27packages = []
28ext_modules = []
29
30# Remove all files that should be updated by this setup
31# We do this here because application updates these files from .sasview
32# except when there is no such file
33# Todo : make this list generic
34# plugin_model_list = ['polynominal5.py', 'sph_bessel_jn.py',
35#                      'sum_Ap1_1_Ap2.py', 'sum_p1_p2.py',
36#                      'testmodel_2.py', 'testmodel.py',
37#                      'polynominal5.pyc', 'sph_bessel_jn.pyc',
38#                      'sum_Ap1_1_Ap2.pyc', 'sum_p1_p2.pyc',
39#                      'testmodel_2.pyc', 'testmodel.pyc', 'plugins.log']
40
41CURRENT_SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
42SASVIEW_BUILD = os.path.join(CURRENT_SCRIPT_DIR, "build")
43
44sas_dir = os.path.join(os.path.expanduser("~"), '.sasview')
45if os.path.isdir(sas_dir):
46    f_path = os.path.join(sas_dir, "sasview.log")
47    if os.path.isfile(f_path):
48        os.remove(f_path)
49    f_path = os.path.join(sas_dir, "categories.json")
50    if os.path.isfile(f_path):
51        os.remove(f_path)
52    f_path = os.path.join(sas_dir, 'config', "custom_config.py")
53    if os.path.isfile(f_path):
54        os.remove(f_path)
55    #f_path = os.path.join(sas_dir, 'plugin_models')
56    # if os.path.isdir(f_path):
57    #     for f in os.listdir(f_path):
58    #         if f in plugin_model_list:
59    #             file_path =  os.path.join(f_path, f)
60    #             os.remove(file_path)
61    if os.path.exists(SASVIEW_BUILD):
62        print("Removing existing build directory",
63              SASVIEW_BUILD, "for a clean build")
64        shutil.rmtree(SASVIEW_BUILD)
65
66# 'sys.maxsize' and 64bit: Not supported for python2.5
67is_64bits = False
68if sys.version_info >= (2, 6):
69    is_64bits = sys.maxsize > 2**32
70
71enable_openmp = False
72
73if sys.platform == 'darwin':
74    if not is_64bits:
75        # Disable OpenMP
76        enable_openmp = False
77    else:
78        # Newer versions of Darwin don't support openmp
79        try:
80            darwin_ver = int(os.uname()[2].split('.')[0])
81            if darwin_ver >= 12:
82                enable_openmp = False
83        except:
84            print("PROBLEM determining Darwin version")
85
86# Options to enable OpenMP
87copt = {'msvc': ['/openmp'],
88        'mingw32': ['-fopenmp'],
89        'unix': ['-fopenmp']}
90lopt = {'msvc': ['/MANIFEST'],
91        'mingw32': ['-fopenmp'],
92        'unix': ['-lgomp']}
93
94# Platform-specific link options
95platform_lopt = {'msvc': ['/MANIFEST']}
96platform_copt = {}
97
98# Set copts to get compile working on OS X >= 10.9 using clang
99if sys.platform == 'darwin':
100    try:
101        darwin_ver = int(os.uname()[2].split('.')[0])
102        if darwin_ver >= 13 and darwin_ver < 14:
103            platform_copt = {
104                'unix': ['-Wno-error=unused-command-line-argument-hard-error-in-future']}
105    except:
106        print("PROBLEM determining Darwin version")
107
108
109class DisableOpenMPCommand(Command):
110    description = "The version of MinGW that comes with Anaconda does not come with OpenMP :( "\
111                  "This commands means we can turn off compiling with OpenMP for this or any "\
112                  "other reason."
113    user_options = []
114
115    def initialize_options(self):
116        self.cwd = None
117
118    def finalize_options(self):
119        self.cwd = os.getcwd()
120        global enable_openmp
121        enable_openmp = False
122
123    def run(self):
124        pass
125
126
127class build_ext_subclass(build_ext):
128    def build_extensions(self):
129        # Get 64-bitness
130        c = self.compiler.compiler_type
131        print("Compiling with %s (64bit=%s)" % (c, str(is_64bits)))
132
133        # OpenMP build options
134        if enable_openmp:
135            if c in copt:
136                for e in self.extensions:
137                    e.extra_compile_args = copt[c]
138            if c in lopt:
139                for e in self.extensions:
140                    e.extra_link_args = lopt[c]
141
142        # Platform-specific build options
143        if c in platform_lopt:
144            for e in self.extensions:
145                e.extra_link_args = platform_lopt[c]
146
147        if c in platform_copt:
148            for e in self.extensions:
149                e.extra_compile_args = platform_copt[c]
150
151        build_ext.build_extensions(self)
152
153
154class BuildSphinxCommand(Command):
155    description = "Build Sphinx documentation."
156    user_options = []
157
158    def initialize_options(self):
159        self.cwd = None
160
161    def finalize_options(self):
162        self.cwd = os.getcwd()
163
164    def run(self):
165        ''' First builds the sasmodels documentation if the directory
166        is present. Then builds the sasview docs.
167        '''
168        ### AJJ - Add code for building sasmodels docs here:
169        # check for doc path
170        SASMODELS_DOCPATH = os.path.abspath(os.path.join(os.getcwd(), '..', 'sasmodels', 'doc'))
171        print("========= check for sasmodels at", SASMODELS_DOCPATH, "============")
172        if os.path.exists(SASMODELS_DOCPATH):
173            if os.path.isdir(SASMODELS_DOCPATH):
174                # if available, build sasmodels docs
175                print("============= Building sasmodels model documentation ===============")
176                smdocbuild = subprocess.call(["make", "-C", SASMODELS_DOCPATH, "html"])
177        else:
178            # if not available warning message
179            print("== !!WARNING!! sasmodels directory not found. Cannot build model docs. ==")
180
181        #Now build sasview (+sasmodels) docs
182        sys.path.append("docs/sphinx-docs")
183        import build_sphinx
184        build_sphinx.rebuild()
185
186
187# sas module
188package_dir["sas"] = os.path.join("src", "sas")
189packages.append("sas")
190
191# sas module
192package_dir["sas.sasgui"] = os.path.join("src", "sas", "sasgui")
193packages.append("sas.sasgui")
194
195# sas module
196package_dir["sas.sascalc"] = os.path.join("src", "sas", "sascalc")
197packages.append("sas.sascalc")
198
199# sas.sascalc.invariant
200package_dir["sas.sascalc.invariant"] = os.path.join(
201    "src", "sas", "sascalc", "invariant")
202packages.extend(["sas.sascalc.invariant"])
203
204# sas.sasgui.guiframe
205guiframe_path = os.path.join("src", "sas", "sasgui", "guiframe")
206package_dir["sas.sasgui.guiframe"] = guiframe_path
207package_dir["sas.sasgui.guiframe.local_perspectives"] = os.path.join(
208    os.path.join(guiframe_path, "local_perspectives"))
209package_data["sas.sasgui.guiframe"] = ['images/*', 'media/*']
210packages.extend(
211    ["sas.sasgui.guiframe", "sas.sasgui.guiframe.local_perspectives"])
212# build local plugin
213for d in os.listdir(os.path.join(guiframe_path, "local_perspectives")):
214    if d not in ['.svn', '__init__.py', '__init__.pyc']:
215        package_name = "sas.sasgui.guiframe.local_perspectives." + d
216        packages.append(package_name)
217        package_dir[package_name] = os.path.join(
218            guiframe_path, "local_perspectives", d)
219
220# sas.sascalc.dataloader
221package_dir["sas.sascalc.dataloader"] = os.path.join(
222    "src", "sas", "sascalc", "dataloader")
223package_data["sas.sascalc.dataloader.readers"] = [
224    'defaults.json', 'schema/*.xsd']
225packages.extend(["sas.sascalc.dataloader", "sas.sascalc.dataloader.readers",
226                 "sas.sascalc.dataloader.readers.schema"])
227
228
229# sas.sascalc.calculator
230gen_dir = os.path.join("src", "sas", "sascalc", "calculator", "c_extensions")
231package_dir["sas.sascalc.calculator.core"] = gen_dir
232package_dir["sas.sascalc.calculator"] = os.path.join(
233    "src", "sas", "sascalc", "calculator")
234packages.extend(["sas.sascalc.calculator", "sas.sascalc.calculator.core"])
235ext_modules.append(Extension("sas.sascalc.calculator.core.sld2i",
236                             sources=[
237                                 os.path.join(gen_dir, "sld2i_module.cpp"),
238                                 os.path.join(gen_dir, "sld2i.cpp"),
239                                 os.path.join(gen_dir, "libfunc.c"),
240                                 os.path.join(gen_dir, "librefl.c"),
241                             ],
242                             include_dirs=[gen_dir],
243                             )
244                   )
245
246# sas.sascalc.pr
247srcdir = os.path.join("src", "sas", "sascalc", "pr", "c_extensions")
248package_dir["sas.sascalc.pr.core"] = srcdir
249package_dir["sas.sascalc.pr"] = os.path.join("src", "sas", "sascalc", "pr")
250packages.extend(["sas.sascalc.pr", "sas.sascalc.pr.core"])
251ext_modules.append(Extension("sas.sascalc.pr.core.pr_inversion",
252                             sources=[os.path.join(srcdir, "Cinvertor.c"),
253                                      os.path.join(srcdir, "invertor.c"),
254                                      ],
255                             include_dirs=[],
256                             ))
257
258
259# sas.sascalc.file_converter
260mydir = os.path.join("src", "sas", "sascalc", "file_converter", "c_ext")
261package_dir["sas.sascalc.file_converter.core"] = mydir
262package_dir["sas.sascalc.file_converter"] = os.path.join(
263    "src", "sas", "sascalc", "file_converter")
264packages.extend(["sas.sascalc.file_converter",
265                 "sas.sascalc.file_converter.core"])
266ext_modules.append(Extension("sas.sascalc.file_converter.core.bsl_loader",
267                             sources=[os.path.join(mydir, "bsl_loader.c")],
268                             include_dirs=[np.get_include()],
269                             ))
270
271# sas.sascalc.corfunc
272package_dir["sas.sascalc.corfunc"] = os.path.join(
273    "src", "sas", "sascalc", "corfunc")
274
275packages.extend(["sas.sascalc.corfunc"])
276
277# sas.sascalc.fit
278package_dir["sas.sascalc.fit"] = os.path.join("src", "sas", "sascalc", "fit")
279packages.append("sas.sascalc.fit")
280
281# Perspectives
282package_dir["sas.sasgui.perspectives"] = os.path.join(
283    "src", "sas", "sasgui", "perspectives")
284package_dir["sas.sasgui.perspectives.pr"] = os.path.join(
285    "src", "sas", "sasgui", "perspectives", "pr")
286packages.extend(["sas.sasgui.perspectives", "sas.sasgui.perspectives.pr"])
287package_data["sas.sasgui.perspectives.pr"] = ['media/*']
288
289package_dir["sas.sasgui.perspectives.invariant"] = os.path.join(
290    "src", "sas", "sasgui", "perspectives", "invariant")
291packages.extend(["sas.sasgui.perspectives.invariant"])
292package_data['sas.sasgui.perspectives.invariant'] = [
293    os.path.join("media", '*')]
294
295package_dir["sas.sasgui.perspectives.fitting"] = os.path.join(
296    "src", "sas", "sasgui", "perspectives", "fitting")
297package_dir["sas.sasgui.perspectives.fitting.plugin_models"] = os.path.join(
298    "src", "sas", "sasgui", "perspectives", "fitting", "plugin_models")
299packages.extend(["sas.sasgui.perspectives.fitting",
300                 "sas.sasgui.perspectives.fitting.plugin_models"])
301package_data['sas.sasgui.perspectives.fitting'] = [
302    'media/*', 'plugin_models/*']
303
304packages.extend(["sas.sasgui.perspectives",
305                 "sas.sasgui.perspectives.calculator"])
306package_data['sas.sasgui.perspectives.calculator'] = ['images/*', 'media/*']
307
308package_dir["sas.sasgui.perspectives.corfunc"] = os.path.join(
309    "src", "sas", "sasgui", "perspectives", "corfunc")
310packages.extend(["sas.sasgui.perspectives.corfunc"])
311package_data['sas.sasgui.perspectives.corfunc'] = ['media/*']
312
313package_dir["sas.sasgui.perspectives.file_converter"] = os.path.join(
314    "src", "sas", "sasgui", "perspectives", "file_converter")
315packages.extend(["sas.sasgui.perspectives.file_converter"])
316package_data['sas.sasgui.perspectives.file_converter'] = ['media/*']
317
318# Data util
319package_dir["sas.sascalc.data_util"] = os.path.join(
320    "src", "sas", "sascalc", "data_util")
321packages.append("sas.sascalc.data_util")
322
323# Plottools
324package_dir["sas.sasgui.plottools"] = os.path.join(
325    "src", "sas", "sasgui", "plottools")
326packages.append("sas.sasgui.plottools")
327
328# # Last of the sas.models
329# package_dir["sas.models"] = os.path.join("src", "sas", "models")
330# packages.append("sas.models")
331
332EXTENSIONS = [".c", ".cpp"]
333
334
335def append_file(file_list, dir_path):
336    """
337    Add sources file to sources
338    """
339    for f in os.listdir(dir_path):
340        if os.path.isfile(os.path.join(dir_path, f)):
341            _, ext = os.path.splitext(f)
342            if ext.lower() in EXTENSIONS:
343                file_list.append(os.path.join(dir_path, f))
344        elif os.path.isdir(os.path.join(dir_path, f)) and \
345                not f.startswith("."):
346            sub_dir = os.path.join(dir_path, f)
347            for new_f in os.listdir(sub_dir):
348                if os.path.isfile(os.path.join(sub_dir, new_f)):
349                    _, ext = os.path.splitext(new_f)
350                    if ext.lower() in EXTENSIONS:
351                        file_list.append(os.path.join(sub_dir, new_f))
352
353
354# Comment out the following to avoid rebuilding all the models
355file_sources = []
356append_file(file_sources, gen_dir)
357
358# Wojtek's hacky way to add doc files while bundling egg
359# def add_doc_files(directory):
360#    paths = []
361#    for (path, directories, filenames) in os.walk(directory):
362#        for filename in filenames:
363#            paths.append(os.path.join(path, filename))
364#    return paths
365
366#doc_files = add_doc_files('doc')
367
368# SasView
369package_dir["sas.sasview"] = "sasview"
370package_data['sas.sasview'] = ['images/*',
371                               'media/*',
372                               'logging.ini',
373                               'test/*.txt',
374                               'test/1d_data/*',
375                               'test/2d_data/*',
376                               'test/convertible_files/*',
377                               'test/coordinate_data/*',
378                               'test/image_data/*',
379                               'test/media/*',
380                               'test/other_files/*',
381                               'test/save_states/*',
382                               'test/sesans_data/*'
383                               ]
384packages.append("sas.sasview")
385
386required = [
387    'bumps>=0.7.5.9', 'periodictable>=1.3.1', 'pyparsing<2.0.0',
388
389    # 'lxml>=2.2.2',
390    'lxml', 'h5py',
391
392    # The following dependecies won't install automatically, so assume them
393    # The numbers should be bumped up for matplotlib and wxPython as well.
394    # 'numpy>=1.4.1', 'scipy>=0.7.2', 'matplotlib>=0.99.1.1',
395    # 'wxPython>=2.8.11', 'pil',
396]
397
398if os.name == 'nt':
399    required.extend(['html5lib', 'reportlab'])
400else:
401    # 'pil' is now called 'pillow'
402    required.extend(['pillow'])
403
404# Set up SasView
405setup(
406    name="sasview",
407    version=VERSION,
408    description="SasView application",
409    author="SasView Team",
410    author_email="developers@sasview.org",
411    url="http://sasview.org",
412    license="PSF",
413    keywords="small-angle x-ray and neutron scattering analysis",
414    download_url="https://github.com/SasView/sasview.git",
415    package_dir=package_dir,
416    packages=packages,
417    package_data=package_data,
418    ext_modules=ext_modules,
419    install_requires=required,
420    zip_safe=False,
421    entry_points={
422        'console_scripts': [
423            "sasview = sas.sasview.sasview:run",
424        ]
425    },
426    cmdclass={'build_ext': build_ext_subclass,
427              'docs': BuildSphinxCommand,
428              'disable_openmp': DisableOpenMPCommand}
429)
Note: See TracBrowser for help on using the repository browser.