InSpice 1.5__tar.gz

inspice-1.5/InSpice/Config/ConfigInstall.py

@@ -0,0 +1,65 @@
+####################################################################################################
+
+import os
+import sys
+
+####################################################################################################
+
+import InSpice.Tools.Path as PathTools # Fixme: why ?
+
+####################################################################################################
+
+class OsFactory:
+
+    ##############################################
+
+    def __init__(self):
+
+        if sys.platform.startswith('linux'):
+            self._name = 'linux'
+        elif sys.platform.startswith('win'):
+            self._name = 'windows'
+        elif sys.platform.startswith('darwin'):
+            self._name = 'osx'
+
+    ##############################################
+
+    @property
+    def name(self):
+        return self._name
+
+    @property
+    def on_linux(self):
+        return self._name == 'linux'
+
+    @property
+    def on_windows(self):
+        return self._name == 'windows'
+
+    @property
+    def on_osx(self):
+        return self._name == 'osx'
+
+OS = OsFactory()
+
+####################################################################################################
+
+_this_file = PathTools.to_absolute_path(__file__)
+
+class Path:
+
+    InSpice_module_directory = PathTools.parent_directory_of(_this_file, step=2)
+    config_directory = os.path.dirname(_this_file)
+
+####################################################################################################
+
+class Logging:
+
+    default_config_file = 'logging.yml'
+    directories = (Path.config_directory,)
+
+    ##############################################
+
+    @staticmethod
+    def find(config_file):
+        return PathTools.find(config_file, Logging.directories)

inspice-1.5/InSpice/Config/logging.yml

@@ -0,0 +1,44 @@
+####################################################################################################
+
+version: 1
+
+####################################################################################################
+
+formatters:
+
+  simple:
+    format: '%(asctime)s - %(name)s - %(module)s.%(levelname)s - %(message)s'
+
+  ansi:
+#   RESET_SEQ = "\033[0m"
+#   COLOR_SEQ = "\033[1;%dm"
+#   BOLD_SEQ = "\033[1m"
+    format: '<ESC>[1;32m%(asctime)s<ESC>[0m - <ESC>[1;34m%(name)s.%(funcName)s<ESC>[0m - <ESC>[1;31m%(levelname)s<ESC>[0m - %(message)s'
+
+####################################################################################################
+
+handlers:
+
+  console:
+    class: logging.StreamHandler
+    # level: INFO
+    # formatter: ansi
+    stream: ext://sys.stdout
+
+####################################################################################################
+
+root:
+  level: INFO
+  # level: WARNING
+  # level: DEBUG
+  handlers: [console]
+
+####################################################################################################
+
+# loggers:
+
+#   InSpice:
+#     level: DEBUG
+#     #level: INFO
+#     #level: WARNING
+#     handlers: [console]

inspice-1.5/InSpice/DeviceLibrary/__init__.py

@@ -0,0 +1,106 @@
+####################################################################################################
+#
+# InSpice - A Spice Package for Python
+# Copyright (C) 2017 Fabrice Salvaire
+#
+# 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.
+#
+# 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/>.
+#
+####################################################################################################
+
+####################################################################################################
+
+class Manufacturer:
+
+    ##############################################
+
+    def __init__(self,
+                 name,
+                 url=None,
+    ):
+
+        self._name = name
+        self._url = url
+
+    ##############################################
+
+    @property
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, value):
+        self._name = value
+
+    @property
+    def url(self):
+        return self._url
+
+    @url.setter
+    def url(self, value):
+        self._url = value
+
+####################################################################################################
+
+class Footprint:
+
+    ##############################################
+
+    def __init__(self,
+                 name,
+    ):
+
+        self._name = name
+
+    ##############################################
+
+    @property
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, value):
+        self._name = value
+
+####################################################################################################
+
+class Device:
+
+    ##############################################
+
+    def __init__(self,
+                 name,
+                 manufacturer,
+                 datasheet_url=None,
+                 model_url=None
+    ):
+
+        # part
+        # part_number
+        # footprint
+        # description
+        # device_category x/y
+        # pins
+        # features / parameters
+
+        self._name = name
+
+    ##############################################
+
+    @property
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, value):
+        self._name = value

inspice-1.5/InSpice/Doc/ExampleTools.py

@@ -0,0 +1,48 @@
+####################################################################################################
+#
+# InSpice - A Spice Package for Python
+# Copyright (C) 2017 Fabrice Salvaire
+#
+# 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.
+#
+# 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 logging
+import os
+import sys
+
+from InSpice.Tools.Path import parent_directory_of
+
+####################################################################################################
+
+_module_logger = logging.getLogger(__name__)
+
+####################################################################################################
+
+def find_libraries():
+
+    try:
+        library_path = os.environ['InSpiceLibraryPath']
+    except KeyError:
+        # Fixme: only works for one level
+        python_file = os.path.abspath(sys.argv[0])
+        examples_root = parent_directory_of(python_file, step=2)
+        # .../InSpice/examples/diode/__example_rst_factory__nlrrr2fh.py .../InSpice/examples
+        library_path = os.path.join(examples_root, 'libraries')
+
+    _module_logger.info('SPICE library path is {}'.format(library_path))
+
+    return library_path

inspice-1.5/InSpice/Logging/Logging.py

@@ -0,0 +1,69 @@
+####################################################################################################
+#
+# InSpice - A Spice Package for Python
+# Copyright (C) 2014 Fabrice Salvaire
+#
+# 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.
+#
+# 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 yaml
+import logging
+import logging.config
+import os
+
+####################################################################################################
+
+import InSpice.Config.ConfigInstall as ConfigInstall
+
+####################################################################################################
+
+def setup_logging(application_name='InSpice',
+                  config_file=ConfigInstall.Logging.default_config_file,
+                  logging_level=None):
+
+    """Setup the logging.
+
+    Logging configuration is set by a YAML file given by *config_file*.  Alternatively we can set
+    the logging level using the environment variable 'InSpiceLogLevel' or using *logging_level*,
+    level can be a integer or a string
+
+    """
+
+    logging_config_file_name = ConfigInstall.Logging.find(config_file)
+    logging_config = yaml.load(open(logging_config_file_name, 'r'), Loader=yaml.SafeLoader)
+
+    if ConfigInstall.OS.on_linux:
+        # Fixme: \033 is not interpreted in YAML
+        formatter_config = logging_config['formatters']['ansi']['format']
+        logging_config['formatters']['ansi']['format'] = formatter_config.replace('<ESC>', '\033')
+
+    if ConfigInstall.OS.on_windows or ConfigInstall.OS.on_osx:
+        formatter = 'simple'
+    else:
+        formatter = 'ansi'
+    logging_config['handlers']['console']['formatter'] = formatter
+
+    logging.config.dictConfig(logging_config)
+
+    logger = logging.getLogger(application_name)
+    if logging_level:
+        logger.setLevel(logging_level)
+    if 'InSpiceLogLevel' in os.environ: # used by tools/make-examples
+        level = getattr(logging, os.environ['InSpiceLogLevel'].upper(), None)
+        logger.setLevel(level) # level can be int or string
+
+    return logger

inspice-1.5/InSpice/Math/Calculus.py

@@ -0,0 +1,164 @@
+####################################################################################################
+#
+# InSpice - A Spice Package for Python
+# Copyright (C) 2014 Fabrice Salvaire
+#
+# 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.
+#
+# 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/>.
+#
+####################################################################################################
+
+"""This module provides algorithms to compute the derivative of a function sampled on an uniform
+grid.
+"""
+
+####################################################################################################
+
+import fractions
+
+import numpy as np
+
+####################################################################################################
+
+from InSpice.Math import odd
+
+####################################################################################################
+
+def compute_exact_finite_difference_coefficients(derivative_order, grid, x0=0):
+
+    """This function compute the finite difference coefficients for the given derivative order and
+    grid.  The parameter *x* specifies where is computed the derivative on the grid.  The grid is
+    given as a list of integer offsets.
+
+    The algorithm is derived from the article: Generation of Finite Difference Formulas on Arbitrary Space
+    Grids, Bengt Fornberg, Mathematics of computation, volume 51, number 184, october 1988
+    """
+
+    N = len(grid)
+
+    # d[m,n,v]
+    d = [[[0
+           for v in range(N)]
+          for n in range(N)]
+         for m in range(derivative_order +1)]
+
+    d[0][0][0] = fractions.Fraction(1,1)
+    c1 = 1
+    for n in range(1, N):
+        c2 = 1
+        for v in range(n):
+            c3 = grid[n] - grid[v]
+            c2 *= c3
+            if n <= derivative_order:
+                d[n][n-1][v] = 0
+            for m in range(min(n, derivative_order) +1):
+                d[m][n][v] = ( (grid[n] - x0)*d[m][n-1][v] - m*d[m-1][n-1][v] ) / c3
+        for m in range(min(n, derivative_order) +1):
+            d[m][n][n] = fractions.Fraction(c1,c2)*( m*d[m-1][n-1][n-1] - (grid[n-1] - x0)*d[m][n-1][n-1] )
+        c1 = c2
+
+    return d[-1][-1]
+
+####################################################################################################
+
+def compute_finite_difference_coefficients(derivative_order, grid):
+    return [float(x) for x in compute_exact_finite_difference_coefficients(derivative_order, grid)]
+
+####################################################################################################
+
+_coefficient_cache = dict(centred={}, forward={}, backward={})
+
+def get_finite_difference_coefficients(derivative_order, accuracy_order, grid_type):
+
+    if derivative_order < 1:
+        raise ValueError("Wrong derivative order")
+
+    if odd(accuracy_order) or accuracy_order < 2:
+        raise ValueError("Wrong accuracy order")
+
+    if grid_type == 'centred':
+        window_size = accuracy_order // 2
+        grid = list(range(-window_size, window_size +1))
+    elif grid_type == 'forward':
+        grid = list(range(derivative_order + accuracy_order))
+    elif grid_type == 'backward':
+        grid = list(range(-(derivative_order + accuracy_order) +1, 1))
+        grid = list(reversed(grid)) # Fixme: why ?
+    else:
+        raise ValueError("Wrong grid type")
+
+    key = '{}-{}'.format(derivative_order, accuracy_order)
+    coefficients = _coefficient_cache[grid_type].get(key, None)
+    if coefficients is None:
+        coefficients = compute_finite_difference_coefficients(derivative_order, grid)
+        _coefficient_cache[grid_type][key] = coefficients
+
+    return grid, coefficients
+
+####################################################################################################
+
+def simple_derivative(x, values):
+    """ Compute the derivative as a simple slope. """
+    return x[:-1], np.diff(values)/np.diff(x)
+
+####################################################################################################
+
+def derivative(x, values, derivative_order=1, accuracy_order=4):
+
+    """Compute the derivative at the given derivative order and accuracy order. The precision of the
+    Taylor expansion is :math:`\mathcal{O}(dx^{accuracy})`.
+    """
+
+    dx = np.diff(x)
+    # if not np.all(dx == dx[0]):
+    #     raise ValueError("Sampling is not uniform")
+    dx = dx[0]
+
+    values_size, = values.shape
+
+    derivative = np.zeros(values_size, dtype=values.dtype)
+
+    grid, coefficients = get_finite_difference_coefficients(derivative_order, accuracy_order, 'centred')
+    window_size = grid[-1]
+    # print grid, coefficients
+    vector_size = values_size - 2*window_size
+    if not vector_size:
+        raise ValueError("The size of the value's array is not sufficient for the given accuracy order")
+    lower_index = window_size
+    upper_index = values_size - window_size
+    derivative_view = derivative[window_size:-window_size]
+    for offset, coefficient in zip(grid, coefficients):
+        if coefficient:
+            # print offset, lower_index + offset, upper_index + offset
+            derivative_view += values[lower_index + offset:upper_index + offset] * coefficient
+
+    grid, coefficients = get_finite_difference_coefficients(derivative_order, accuracy_order, 'forward')
+    # print grid, coefficients
+    grid_size = len(grid)
+    upper_index = window_size
+    derivative_view = derivative[:window_size]
+    for offset, coefficient in zip(grid, coefficients):
+        # print offset, offset, window_size+offset
+        derivative_view += values[offset:upper_index + offset] * coefficient
+
+    grid, coefficients = get_finite_difference_coefficients(derivative_order, accuracy_order, 'backward')
+    # print grid, coefficients
+    grid_size = len(grid)
+    lower_index = values_size - window_size
+    upper_index = values_size
+    derivative_view = derivative[-window_size:]
+    for offset, coefficient in zip(grid, coefficients):
+        # print offset, lower_index + offset, upper_index + offset
+        derivative_view += values[lower_index + offset:upper_index + offset] * coefficient
+
+    return derivative / dx**derivative_order

inspice-1.5/InSpice/Math/__init__.py

@@ -0,0 +1,46 @@
+####################################################################################################
+#
+# InSpice - A Spice Package for Python
+# Copyright (C) 2014 Fabrice Salvaire
+#
+# 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.
+#
+# 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/>.
+#
+####################################################################################################
+
+"""This module implements mathematical functions.
+"""
+
+####################################################################################################
+
+import math
+
+####################################################################################################
+
+def odd(x):
+    """Return True is *x* is odd"""
+    return x & 1
+
+def even(x):
+    """Return True is *x* is even"""
+    return not(odd(x))
+
+####################################################################################################
+
+def rms_to_amplitude(x):
+    """Return :math:`x \sqrt{2}`"""
+    return x * math.sqrt(2)
+
+def amplitude_to_rms(x):
+    """Return :math:`x / \sqrt{2}`"""
+    return x / math.sqrt(2)

inspice-1.5/InSpice/Physics/MaterialProperties.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+
+####################################################################################################
+#
+# InSpice - A Spice Package for Python
+# Copyright (C) 2014 Fabrice Salvaire
+#
+# 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.
+#
+# 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/>.
+#
+####################################################################################################
+
+####################################################################################################
+
+class Copper:
+
+    atomic_number = 29
+
+    atomic_mass = 63.546 * 1e-3 # kg
+    density = 8.96 * 1e3 # kg·m−3
+    thermal_conductivity = 401 # W·m−1·K−1
+    electrical_resistivity = 16.78 * 1e-9 # Ω·m @20 °C
+    electron_mobility = - 4.6 * 1e3 # m2·V−1·s−1
+
+    ##############################################
+
+    def electrical_resistance_for_conductor(self, degree):
+        """ Used to compute conductor resistance. """
+        rho0 = 16e-3 # Ω·m·mm−2
+        return rho0 * (1 + .00393 * degree)

inspice-1.5/InSpice/Physics/PhysicalConstants.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+
+####################################################################################################
+#
+# InSpice - A Spice Package for Python
+# Copyright (C) 2014 Fabrice Salvaire
+#
+# 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.
+#
+# 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/>.
+#
+####################################################################################################
+
+####################################################################################################
+#
+# Physical Constants from Particle Data Group 2013
+#   http://pdg.lbl.gov/2013/reviews/rpp2013-rev-phys-constants.pdf
+#
+####################################################################################################
+
+####################################################################################################
+
+pi = 3.141592653589793238 # π = 3.141 592 653 589 793 238
+
+####################################################################################################
+
+speed_of_light_in_vacuum = c = 299792458 # 299 792 458 m s−1
+electron_charge_magnitude = e = q = 1.602176565e-19 # 1.602 176 565(35)×10−19 C = 4.803 204 50(11)×10−10 esu
+
+permeability_of_free_space = mu0 = 4*pi*1e-7 # 4π × 10−7 N A−2 = 12.566 370 614 ... ×10−7 N A−2
+permittivity_of_free_space = epsilon0 = 1./(mu0*c**2) # 8.854 187 817 ... ×10−12 F m −1
+
+avogadro_constant = Na = 6.02214129e23 # 6.022 141 29(27)×1023 mol−1
+boltzmann_constant = k = 1.3806488e-23 # 1.380 6488(13)×10−23 J K−1 = 8.617 3324(78)×10−5 eV K−1
+
+# 1 eV = 1.602 176 565(35) × 10−19 J
+# 1 eV/c2 = 1.782 661 845(39) × 10−36 kg
+
+####################################################################################################
+
+# 0 ◦C ≡ 273.15 K
+def degree_to_kelvin(x):
+    return x + 273.15
+def kelvin_to_degree(x):
+    return x - 273.15
+
+def temperature(degree=None, kelvin=None):
+    if degree is not None:
+        return degree_to_kelvin(degree)
+    else:
+        return kelvin
+
+# kT at 300 K = [38.681 731(35)]−1 eV
+def kT(degree=None, kelvin=None):
+    return k*temperature(degree=degree, kelvin=kelvin)

inspice-1.5/InSpice/Physics/Resistor.py

@@ -0,0 +1,30 @@
+####################################################################################################
+#
+# InSpice - A Spice Package for Python
+# Copyright (C) 2014 Fabrice Salvaire
+#
+# 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.
+#
+# 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/>.
+#
+####################################################################################################
+
+####################################################################################################
+#
+# Notes: Drude model, Nernst-Einstein law
+#
+####################################################################################################
+
+####################################################################################################
+
+def conductor_resistance(resistivity, length, section):
+    return resistivity * length / section