forked from qutip/qutip
-
Notifications
You must be signed in to change notification settings - Fork 1
/
settings.py
135 lines (127 loc) · 5.25 KB
/
settings.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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
# This file is part of QuTiP: Quantum Toolbox in Python.
#
# Copyright (c) 2011 and later, Paul D. Nation and Robert J. Johansson.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the QuTiP: Quantum Toolbox in Python nor the names
# of its contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
###############################################################################
"""
This module contains settings for the QuTiP graphics, multiprocessing, and
tidyup functionality, etc.
"""
from __future__ import absolute_import
# use auto tidyup
auto_tidyup = True
# detect hermiticity
auto_herm = True
# general absolute tolerance
atol = 1e-12
# use auto tidyup absolute tolerance
auto_tidyup_atol = 1e-12
# number of cpus (set at qutip import)
num_cpus = 0
# flag indicating if fortran module is installed
fortran = False
# flag indicating if scikits.umfpack is installed
umfpack = False
# debug mode for development
debug = False
# are we in IPython? Note that this cannot be
# set by the RC file.
ipython = False
# define whether log handler should be
# - default: switch based on IPython detection
# - stream: set up non-propagating StreamHandler
# - basic: call basicConfig
# - null: leave logging to the user
log_handler = 'default'
# Allow for a colorblind mode that uses different colormaps
# and plotting options by default.
colorblind_safe = False
# Note that since logging depends on settings,
# if we want to do any logging here, it must be manually
# configured, rather than through _logging.get_logger().
import logging
_logger = logging.getLogger(__name__)
_logger.addHandler(logging.NullHandler())
del logging # Don't leak names!
def load_rc_file(rc_file):
"""
Load settings for the qutip RC file, by default .qutiprc in the user's home
directory.
"""
global auto_tidyup, auto_herm, auto_tidyup_atol, num_cpus, debug, atol
global log_handler, colorblind_safe
# Try to pull in configobj to do nicer handling of
# config files instead of doing manual parsing.
# We pull it in here to avoid throwing an error if configobj is missing.
try:
import configobj as _cobj
import pkg_resources
import validate
except ImportError:
# Don't bother warning unless the rc_file exists.
import os
if os.path.exists(rc_file):
_logger.warn("configobj missing, not loading rc_file.", exc_info=1)
return
# Try to find the specification for the config file, then
# use it to load the actual config.
config = _cobj.ConfigObj(rc_file,
configspec=pkg_resources.resource_filename('qutip', 'configspec.ini'),
# doesn't throw an error if qutiprc is missing.
file_error=False
)
# Next, validate the loaded config file against the specs.
validator = validate.Validator()
result = config.validate(validator)
# configobj's validator returns the literal True if everything
# worked, and returns a dictionary of which keys fails otherwise.
# This motivates a very un-Pythonic way of checking for results,
# but it's the configobj idiom.
if result != True:
# OK, find which keys are bad.
bad_keys = {key for key, val in result.iteritems() if not val}
_logger.warn('Invalid configuration options in {}: {}'.format(
rc_file, bad_keys
))
else:
bad_keys = {}
# Now that everything's been validated, we apply the config
# file to the global settings.
for config_key in (
'auto_tidyup', 'auto_herm', 'atol', 'auto_tidyup_atol',
'num_cpus', 'debug', 'log_handler', 'colorblind_safe'
):
if config_key in config and config_key not in bad_keys:
_logger.debug(
"Applying configuration setting {} = {}.".format(
config_key, config[config_key]
)
)
globals()[config_key] = config[config_key]