InSpice 1.6__tar.gz

inspice-1.6/InSpice/Cache/__init__.py

@@ -0,0 +1,174 @@
+####################################################################################################
+#
+# InSpice - A Spice Package for Python
+# Copyright (C) 2021 Fabrice Salvaire
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+####################################################################################################
+
+# Simulation outputs should be identical if
+#   same simulator and version
+#   same inputs
+
+__all__ = ["SimulationCache"]
+
+####################################################################################################
+
+from pathlib import Path
+import hashlib
+
+# http://www.grantjenks.com/docs/diskcache
+from diskcache import Cache
+
+####################################################################################################
+
+class SpiceInclude:
+
+    INCLUDE_PREFIX = '.include '
+
+    ##############################################
+
+    def __init__(self, path: str | Path):
+        self._path = Path(path)
+        self._inner_includes = []
+        self._walk()
+        self._digest = self.sha1()
+        self._recursive_digest = self._compute_recursive_digest()
+
+    ##############################################
+
+    @property
+    def path(self) -> Path:
+        return self._path
+
+    ##############################################
+
+    def _compute_digest(self, func) -> str:
+        with open(self._path, 'rb') as fh:
+            _ = func(fh.read()).hexdigest()
+        return _
+
+    ##############################################
+
+    def sha1(self) -> str:
+        return self._compute_digest(hashlib.sha1)
+
+    ##############################################
+
+    @classmethod
+    def parse_include(self, line):
+        line = line.strip()
+        if line.startswith(self.INCLUDE_PREFIX):
+            path = line[len(self.INCLUDE_PREFIX):].strip()
+            if path:
+                return Path(path)
+        return None
+
+    ##############################################
+
+    def _walk(self) -> None:
+        with open(self._path, 'r') as fh:
+            for line in fh.readlines():
+                path = self.parse_include(line)
+                if path is not None:
+                    include = SpiceInclude(path)
+                    self._inner_includes.append(include)
+
+    ##############################################
+
+    def _compute_recursive_digest(self) -> str:
+        if self._inner_includes:
+            return self._digest + '[' + '/'.join([_.digest for _ in self._inner_includes]) + ']'
+        else:
+            return self._digest
+
+    ##############################################
+
+    @property
+    def digest(self) -> str:
+        return self._digest
+
+    @property
+    def recursive_digest(self) -> str:
+        return self._recursive_digest
+
+    @property
+    def inner_includes(self) -> str:
+        return iter(self._inner_includes)
+
+####################################################################################################
+
+class SimulationCache:
+
+    ##############################################
+
+    def __init__(self, path: str | Path=None):
+        """
+        Cache directory will be set to a temporary directory like "/tmp/diskcache-...", if *Path* is None.
+        """
+        self._cache = Cache(path)
+
+    ##############################################
+
+    def __del__(self):
+        # Each thread that accesses a cache should also call close on the cache.
+        self._cache.close()
+
+    ##############################################
+
+    @property
+    def impl(self) -> Cache:
+        return self._cache
+
+    @property
+    def directory(self) -> str:
+        return self._cache.directory
+
+    ##############################################
+
+    def simulation_key(self, simulation) -> str:
+        raw_spice_code = str(simulation)
+        lines = []
+        # Replace .include lines by recursive digest
+        for line in raw_spice_code.splitlines():
+        #  for path in simulation.circuit.includes:
+            path = SpiceInclude.parse_include(line)
+            if path is not None:
+                include = SpiceInclude(path)
+                lines.append(f'.include {include.path.name} {include.recursive_digest}')
+            else:
+                lines.append(line)
+        # Replace os.linesep to a portable separator
+        spice_code = '@@'.join(lines)
+        return f'{simulation.simulator_name}/{simulation.simulator_version}/{spice_code}'
+
+    ##############################################
+
+    def add(self, analysis):
+        pass
+
+    ##############################################
+
+    def get(self, simulation):
+        pass
+
+####################################################################################################
+
+class CachedSimulation:
+
+    ##############################################
+
+    def __init__(self, spice_code):
+        pass

inspice-1.6/InSpice/Config/ConfigInstall.py

@@ -0,0 +1,65 @@
+####################################################################################################
+
+from pathlib import Path
+
+import sys
+
+####################################################################################################
+
+from InSpice.Tools import PathTools
+
+####################################################################################################
+
+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 = Path(__file__).absolute()
+
+class Path:
+
+    InSpice_module_directory = _this_file.parents[1]
+    config_directory = _this_file.parent
+
+####################################################################################################
+
+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.6/InSpice/Config/logging.yml

@@ -0,0 +1,51 @@
+####################################################################################################
+#
+# ANSI Codes
+#
+#   RESET \033[0m
+#   COLOR \033[1;%dm
+#   BOLD  \033[1m
+#
+####################################################################################################
+
+version: 1
+
+####################################################################################################
+
+formatters:
+
+  simple:
+    format: '%(asctime)s - %(name)s - %(module)s.%(levelname)s - %(message)s'
+
+  ansi:
+    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
+
+####################################################################################################
+
+# InSpice.Doc.ExampleTools.find_libraries
+root:
+  # level: CRITICAL
+  # level: ERROR
+  level: WARNING
+  # level: INFO
+  # level: DEBUG
+  handlers: [console]
+
+####################################################################################################
+
+loggers:
+
+  InSpice:
+    # level: DEBUG
+    level: INFO
+    # level: WARNING

inspice-1.6/InSpice/DeviceLibrary/__init__.py

@@ -0,0 +1,105 @@
+####################################################################################################
+#
+# 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 Affero 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://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.6/InSpice/Doc/ExampleTools.py

@@ -0,0 +1,49 @@
+####################################################################################################
+#
+# 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 Affero 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+####################################################################################################
+
+__all__ = ['find_libraries', 'LIBRARY_PATH']
+
+####################################################################################################
+
+from pathlib import Path
+import logging
+import os
+import sys
+
+####################################################################################################
+
+_module_logger = logging.getLogger(__name__)
+
+####################################################################################################
+
+LIBRARY_PATH = 'spice-library'
+
+def find_libraries(root: str='examples') -> Path:
+    try:
+        library_path = os.environ['InSpiceLibraryPath']
+    except KeyError:
+        examples_root = Path(sys.argv[0]).resolve()   # path of the Python file
+        while True:
+            examples_root = examples_root.parents[1]
+            if examples_root.name == root:
+                break
+        library_path = examples_root.joinpath(LIBRARY_PATH)
+    _module_logger.info(f'SPICE library path is {library_path}')
+    return library_path

inspice-1.6/InSpice/Export/Hdf5.py

@@ -0,0 +1,126 @@
+####################################################################################################
+#
+# InSpice - A Spice Package for Python
+# Copyright (C) 2021 Fabrice Salvaire
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+####################################################################################################
+
+__all__ = ["Hdf5File"]
+
+####################################################################################################
+
+# File structure
+#   using h5ls -r simulation.hdf5
+#
+# /                        Group
+# /version                 Dataset {SCALAR}
+# /simulation              Group
+# /abscissas               Group
+# /abscissas/time          Dataset {10038}
+# /branches                Group
+# /branches/e.xdz.ev1      Dataset {10038}
+# /branches/...
+# /elements                Group
+# /internal_parameters     Group
+# /nodes                   Group
+# /nodes/1                 Dataset {10038}
+# /nodes/...
+
+# h5dump -g "/simulation" simulation.hdf5
+# h5dump -d "/abscissas/time" simulation.hdf5
+# h5dump -d "/nodes/1" simulation.hdf5
+
+####################################################################################################
+
+import pickle
+
+import numpy as np
+
+# https://docs.h5py.org/en/stable/index.html
+import h5py
+
+####################################################################################################
+
+class Hdf5File:
+
+    _VERSION = 1
+
+    ##############################################
+
+    @classmethod
+    def save(cls, analysis, path):
+        self = cls(path, 'w')
+        self._save(analysis)
+
+    ##############################################
+
+    def __init__(self, path, mode=None):
+        self._file = h5py.File(path, mode)
+
+    ##############################################
+
+    def _save(self, analysis):
+        self._file["version"] = self._VERSION
+
+        simulation = analysis.simulation
+        group = self._file.create_group("simulation")
+        attrs = group.attrs
+        attrs["simulator"] = simulation.simulator.SIMULATOR
+        attrs["simulator_version"] = simulation.simulator_version
+        attrs["simulation_date"] = str(simulation.simulation_date)
+        attrs["simulation_duration"] = str(simulation.simulation_duration)
+        attrs["spice_circuit"] = str(simulation.circuit)
+        attrs["spice_simulation"] = str(simulation) # Fixme: remove desk
+        # https://docs.h5py.org/en/stable/strings.html#how-to-store-raw-binary-data
+        attrs["pickled_simulation"] = np.void(pickle.dumps(simulation))
+
+        self._abscissa = self._file.create_group("abscissas")
+        for list_name in ("nodes", "branches", "elements", "internal_parameters"):
+            group = self._file.create_group(list_name)
+            for waveform in getattr(analysis, list_name).values():
+                self._add_waveform(group, waveform)
+
+    ##############################################
+
+    def _add_waveform_common(self, group, waveform):
+        dset = group.create_dataset(
+            waveform.name,
+            data=waveform,
+            compression="gzip", compression_opts=9
+            # compression="lzf
+        )
+        attrs = dset.attrs
+        attrs["unit"] = str(waveform.unit)
+        return dset
+
+    ##############################################
+
+    def _add_abscissa(self, abscissa):
+        # Fixme: is time always unique ???
+        # See https://docs.h5py.org/en/stable/high/group.html#hard-links
+        if abscissa.name not in self._abscissa:
+            # self._abscissa[abscissa.name] = abscissa
+            self._add_waveform_common(self._abscissa, abscissa)
+        return self._abscissa[abscissa.name]
+
+    ##############################################
+
+    def _add_waveform(self, group, waveform):
+        dset = self._add_waveform_common(group, waveform)
+        attrs = dset.attrs
+        if waveform.title:
+            attrs["title"] = waveform.title
+        attrs["abscissa"] = self._add_abscissa(waveform.abscissa).ref