moreniius 0.5.2__py3-none-any.whl → 0.6.1__py3-none-any.whl

moreniius/mccode/comp.py

@@ -95,27 +95,41 @@ def diskchopper_translator(nxinstance):
     return nxinstance.make_nx(NXdisk_chopper, slit_edges=NXfield(nx_slit_edges, units='degrees'), **resolve_parameter_links(pars))
 
 
-def elliptic_guide_gravity_translator(nxinstance):
-    from nexusformat.nexus import NXguide
+def _ellipse_vertices_faces(major_x, minor_x, offset_x, major_y, minor_y, offset_y, l, n=10):
+    """
+    Create vertices and faces for an elliptical guide with given parameters.
+
+    Parameters
+    ----------
+    major_x : float
+        Major axis half-length in the x-direction.
+    minor_x : float
+        Minor axis half-length in the x-direction.
+    offset_x : float
+        Offset from the end of the ellipse to the guide entrance in the x-direction.
+    major_y : float
+        Major axis half-length in the y-direction.
+    minor_y : float
+        Minor axis half-length in the y-direction.
+    offset_y : float
+        Offset from the end of the ellipse to the guide entrance in the y-direction.
+    l : float
+        Length of the guide. l <= 2*major_x - offset_x and l <= 2*major_y - offset_y
+    n : int, optional
+        Number of segments along the length of the guide. Default is 10.
+    """
     from numpy import arange, sqrt
-    from moreniius.nxoff import NXoff
-    if not '"mid"' == nxinstance.obj.get_parameter('dimensionsAt'):
-        log.warn('Only midpoint geometry supported by Elliptic_guide_gravity translator')
-        log.info(f'The current guide has {nxinstance.obj.get_parameter("dimensionsAt")} specified')
 
-    def ellipse_width(minor, distance, at):
-        major = sqrt((distance / 2) ** 2 + minor ** 2)
+    def ellipse_width(minor, major, at):
         return 0 if abs(at) > major else minor * sqrt(1 - (at / major) ** 2)
 
-    pars = dict(xw='xwidth', xi='linxw', xo='loutxw', yw='yheight', yi='linyh', yo='loutyh', l='l')
-    p = {k: nxinstance.parameter(v) for k, v in pars.items()}
-    n = 10
     rings = arange(n + 1) / n
     faces, vertices = [], []
     for x in rings:
-        w = ellipse_width(p['xw'] / 2, p['xi'] + p['l'] + p['xo'], p['xi'] / 2 + (x - 0.5) * p['l'] - p['xo'] / 2)
-        h = ellipse_width(p['yw'] / 2, p['yi'] + p['l'] + p['yo'], p['yi'] / 2 + (x - 0.5) * p['l'] - p['yo'] / 2)
-        z = x * p['l']
+        z = x * l
+        w = ellipse_width(minor_x, major_x, offset_x - minor_x + z)
+        h = ellipse_width(minor_y, major_y, offset_y - minor_y + x)
+
         vertices.extend([[-w, -h, z], [-w, h, z], [w, h, z], [w, -h, z]])
 
     # These are only the guide faces (that is, the inner faces of the sides of the guide housing)
@@ -124,6 +138,55 @@ def elliptic_guide_gravity_translator(nxinstance):
         j0, j1, j2, j3, j4, j5, j6, j7 = [4 * i + k for k in range(8)]
         faces.extend([[j0, j1, j5, j4], [j1, j2, j6, j5], [j2, j3, j7, j6], [j3, j0, j4, j7]])
 
+    return vertices, faces
+
+def _ellipse_parameters_from_widths(nxinstance):
+    from numpy import sqrt
+
+    def parameters(which, w, i, o, l):
+        foci = i + l + o
+        offset = foci / 2 - i
+        if 'mid' in which:
+            minor = w / 2
+            major = sqrt(foci ** 2 + minor ** 2) / 2
+        else:
+            t, b = (o, i) if 'entrance' in which else (i, o)
+            t += l
+            w /= 2
+            b = sqrt(b * b + w * w / 4) + sqrt(t * t + w * w / 4)
+            major = b / 2
+            minor = sqrt(b * b - foci * foci) / 2
+        return major, minor, offset
+
+    pars = dict(xw='xwidth', xi='linxw', xo='loutxw', yw='yheight', yi='linyh', yo='loutyh', l='l')
+    p = {k: nxinstance.parameter(v) for k, v in pars.items()}
+
+    dim_at = str(nxinstance.obj.get_parameter('dimensionsAt').value)
+    major_x, minor_x, offset_x = parameters(dim_at, p['xw'], p['xi'], p['xo'], p['l'])
+    major_y, minor_y, offset_y = parameters(dim_at, p['yw'], p['yi'], p['yo'], p['l'])
+
+    return major_x, minor_x, offset_x, major_y, minor_y, offset_y, p['l']
+
+
+def elliptic_guide_gravity_translator(nxinstance):
+    from nexusformat.nexus import NXguide
+    from moreniius.nxoff import NXoff
+
+    ellipse_pars = [f'{f}{s}' for f in ('majorAxis', 'minorAxis', 'majorAxisOffset') for s in ('xw', 'yh')]
+    if all(nxinstance.obj.defines_parameter(p) for p in ellipse_pars):
+        # we can use the specified ellipse parameters directly
+        major_x = nxinstance.parameter('majorAxisxw')
+        minor_x = nxinstance.parameter('minorAxisxw')
+        offset_x = nxinstance.parameter('majorAxisOffsetxw')
+        major_y = nxinstance.parameter('majorAxisyh')
+        minor_y = nxinstance.parameter('minorAxisyh')
+        offset_y = nxinstance.parameter('majorAxisOffsetyh')
+        l = nxinstance.parameter('l')
+    else:
+        major_x, minor_x, offset_x, major_y, minor_y, offset_y, l = _ellipse_parameters_from_widths(nxinstance)
+
+    vertices, faces = _ellipse_vertices_faces(major_x, minor_x, offset_x, major_y, minor_y, offset_y, l, n=10)
+
     nx_vertices = [[nxinstance.expr2nx(expr) for expr in vector] for vector in vertices]
     nx_faces = [[nxinstance.expr2nx(expr) for expr in face] for face in faces]
 

moreniius/mccode/mccode.py

@@ -1,5 +1,7 @@
 from zenlog import log
 from dataclasses import dataclass, field
+from networkx import DiGraph
+from typing import Union
 from mccode_antlr.instr import Orient
 from .instr import NXInstr
 
@@ -9,9 +11,11 @@ log.level('error')
 @dataclass
 class NXMcCode:
     nx_instr: NXInstr
-    origin_name: str = None
+    origin_name: Union[str, None] = None
     indexes: dict[str, int] = field(default_factory=dict)
     orientations: dict[str, Orient] = field(default_factory=dict)
+    graph: Union[DiGraph, None] = None
+    reversed_graph: Union[DiGraph, None] = None
 
     def __post_init__(self):
         from copy import deepcopy
@@ -37,30 +41,52 @@ class NXMcCode:
             for name in self.orientations:
                 self.orientations[name] = self.orientations[name] - origin
 
+        if self.graph is None:
+            self.graph = self.build_graph()
+        if self.reversed_graph is None:
+            self.reversed_graph = self.graph.reverse(copy=True)
+
     def transformations(self, name):
         from .orientation import NXOrient
         return NXOrient(self.nx_instr, self.orientations[name]).transformations(name)
 
+    def inputs(self, name):
+        """Return the other end of edges ending at the named node"""
+        return list(self.reversed_graph[name])
+
+    def outputs(self, name):
+        """Return the other end of edges starting at the named node"""
+        return list(self.graph[name])
+
     def component(self, name, only_nx=True):
         """Return a NeXus NXcomponent corresponding to the named McStas component instance"""
         from .instance import NXInstance
         instance = self.nx_instr.instr.components[self.indexes[name]]
         transformations = self.transformations(name)
-        nx = NXInstance(self.nx_instr, instance, self.indexes[name], transformations, only_nx=only_nx)
-        if transformations and nx.nx['transformations'] != transformations:
+        nxinst = NXInstance(self.nx_instr, instance, self.indexes[name], transformations, only_nx=only_nx)
+        if transformations and nxinst.nx['transformations'] != transformations:
             # if the component modifed the transformations group, make sure we don't use our version again
             del self.orientations[name]
-        return nx
+        if len(inputs := self.inputs(name)):
+            nxinst.nx.attrs['inputs'] = inputs
+        if len(outputs := self.outputs(name)):
+            nxinst.nx.attrs['outputs'] = outputs
+        return nxinst
 
     def instrument(self, only_nx=True):
-        from .instr import NXInstr
         from nexusformat.nexus import NXinstrument
         nx = NXinstrument()  # this is a NeXus class
         nx['mcstas'] = self.nx_instr.to_nx()
-        # hack the McCode component index into the name of the NeXus group
-        width = len(str(max(self.indexes.values())))
-        for name, index in self.indexes.items():
-            nx_name = f'{index:0{width}d}_{name}'
-            nx[nx_name] = self.component(name, only_nx=only_nx).nx
+        for name in self.indexes.keys():
+            nx[name] = self.component(name, only_nx=only_nx).nx
 
         return nx
+
+    def build_graph(self):
+        # FIXME expand this to a full-description if/when McCode includes graph information
+        graph = DiGraph()
+        names = [x.name for x in self.nx_instr.instr.components]
+        graph.add_nodes_from(names)
+        # By default, any McCode instrument is a linear object:
+        graph.add_edges_from([(names[i], names[i+1]) for i in range(len(names)-1)])
+        return graph

moreniius/moreniius.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+from networkx import Graph
 from mccode_antlr.instr import Instr
 
 
@@ -13,12 +14,13 @@ class MorEniius:
                     origin: str | None = None,
                     only_nx: bool = False,
                     nxlog_root: str | None = None,
-                    absolute_depends_on: bool = False
+                    absolute_depends_on: bool = False,
+                    graph: Graph | None = None,
                     ):
         from nexusformat.nexus import NXfield
         from .mccode import NXMcCode, NXInstr
         nxlog_root = nxlog_root or '/entry/parameters'
-        nx_mccode = NXMcCode(NXInstr(instr, nxlog_root=nxlog_root), origin_name=origin)
+        nx_mccode = NXMcCode(NXInstr(instr, nxlog_root=nxlog_root), origin_name=origin, graph=graph)
         nxs_obj = nx_mccode.instrument(only_nx=only_nx)
         nxs_obj['name'] = NXfield(value=instr.name)
         return cls(nxs_obj, only_nx=only_nx, absolute_depends_on=absolute_depends_on)

moreniius/writer.py

@@ -2,7 +2,7 @@ from zenlog import log
 
 
 def convert_types(obj, only_nx=True):
-    from numpy import dtype, ndarray
+    from numpy import dtype, ndarray, array
     from nexusformat.nexus import NXattr
     py_data_type = type(obj)
     np_data_type = dtype(py_data_type)
@@ -24,11 +24,16 @@ def convert_types(obj, only_nx=True):
                 val = val.tolist()
             if obj.dtype == 'object':
                 (tp, vl) = (dtype(type(obj.nxdata)).name, val)
+                # If still 'object', this will throw an error below
+                if tp == 'object' and isinstance(val, list):
+                    tp = dtype(type(val[0])).name
             else:
                 (tp, vl) = (obj.dtype, val)
         elif not only_nx and hasattr(obj, 'to_json_dict'):
             # Shoe-horn in an object-defined dictionary:
             tp, vl = None, obj.to_json_dict()
+        elif isinstance(obj, list):
+            return convert_types(array(obj))
         else:
             raise RuntimeError(f'unrecognised type {py_data_type} / {np_data_type} for {repr(obj)}')
     else:
@@ -38,7 +43,7 @@ def convert_types(obj, only_nx=True):
     elif tp == 'float64':
         tp = 'double'
     elif tp == 'object':
-        raise RuntimeError(f'Internal logical error attempting to convert {obj}')
+        raise RuntimeError(f'Internal logical error attempting to convert {obj} of type {type(obj)}')
     elif tp == 'int':
         tp = 'int64'
     elif tp == 'float':
@@ -124,8 +129,12 @@ class Writer:
                     attrs = [dict(name='NX_class', dtype='string', values=obj.nxclass)]
                     if len(list(obj)):
                         entry['children'] = self._to_json_dict(obj, only_nx=only_nx, absolute_depends_on=absolute_depends_on)
-                for n, v in obj.attrs.items():
-                    typ, val = convert_types(v, only_nx)
+                for n in obj.attrs:
+                    typ, val = convert_types(obj.attrs[n], only_nx)
+                # FIXME accessing an attribute value via the dict values gives
+                #       a NXattr object *not* the underlying value!?
+                # for n, v in obj.attrs.items():
+                #     typ, val = convert_types(v, only_nx)
                     if absolute_depends_on and n == 'depends_on' and '/' != val[0]:
                         val = _to_absolute(top_obj.nxpath, val)
                     attrs.append(dict(name=n, dtype=typ, values=val) if typ else val)

{moreniius-0.5.2.dist-info → moreniius-0.6.1.dist-info}/METADATA

@@ -1,21 +1,22 @@
 Metadata-Version: 2.4
 Name: moreniius
-Version: 0.5.2
+Version: 0.6.1
 Author-email: Gregory Tucker <gregory.tucker@ess.eu>
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Description-Content-Type: text/markdown
 Requires-Dist: zenlog>=1.1
 Requires-Dist: platformdirs>=3.11
-Requires-Dist: mccode-antlr[hdf5]>=0.15.2
+Requires-Dist: mccode-antlr[hdf5]>=0.16.1
 Requires-Dist: nexusformat>=1.0.6
+Requires-Dist: networkx
 
 # moreniius
 A project to contain custom components required to use `eniius` to produce `NeXus Structure` `JSON` from `mccode-antlr` simulated instruments.

{moreniius-0.5.2.dist-info → moreniius-0.6.1.dist-info}/RECORD

@@ -1,18 +1,18 @@
 moreniius/__init__.py,sha256=33SUBkXWhH5rog5oaGJr1Kwqjhwz97w4E0Da7rArYi4,154
 moreniius/additions.py,sha256=6Hhhc4LDUsnBj27Iil-EFFzQm1xd2M45hfcVQYEjxiI,17615
-moreniius/moreniius.py,sha256=cU3CrfMC1kOnHO77yq5sZfDqRuA38G5kA3RUXFNGP2U,1455
+moreniius/moreniius.py,sha256=UZgQycAed5OWIqxYXZLaD68YUHFgQ8fVb-aCP6hvT9Q,1544
 moreniius/nexus_structure.py,sha256=C_ohhilsE6xdfSpFVhsFEK9EC3sBXPGWxCIGk_4UFvI,1853
 moreniius/nxoff.py,sha256=WHp9wYNn_4Hcx8Nzi9rpX1p8_iwI-AdgTQouSAEG8N4,3288
 moreniius/utils.py,sha256=R81eHjc0EWjMsP-Z8WI9sZkc_QY357z_aYziflQAUEU,9238
-moreniius/writer.py,sha256=BwAyc2_QCUir-zhELYl9OHItXepF3w7nRPTnbZ73XNU,6272
+moreniius/writer.py,sha256=zgrbo7RfAriAGrOpPhFHSwwn3yWG4_ZJndIi6HhTzss,6815
 moreniius/mccode/__init__.py,sha256=1QiZdh90G3gp_WlVpdJB_ZGauoW0GJEQ13Nelaqa5JE,151
-moreniius/mccode/comp.py,sha256=uR1L5nLfYPHhMKd3XnDbqf5xhkfwfPLRnttREc3jqBg,7382
+moreniius/mccode/comp.py,sha256=iaOooI2nIevA0Vhz5jZQJCqXYgmZ3jMm0s3gUtR8Unc,9637
 moreniius/mccode/instance.py,sha256=yydYeMGITlZrVWBVYregBWQ0Sd_2A71hgoyCrLLW-Jk,8058
 moreniius/mccode/instr.py,sha256=D4B3ylD4BMfkiP5t2hx5xop9c7yk7QVSleT1wvpK17E,6161
-moreniius/mccode/mccode.py,sha256=6NEXovuG-6itzlPgPklNOiZQ-MlldKF20p4TxV8n4BA,3228
+moreniius/mccode/mccode.py,sha256=0Ck9xFUHU3EkBGTNIXelMgtLA1JXOs976Sj2wXfMQng,4237
 moreniius/mccode/orientation.py,sha256=khT0jTMXyXkPCoEpDg-eLKulF-J2wIqNhUi1NzFWvto,3907
-moreniius-0.5.2.dist-info/METADATA,sha256=hUDFpdKb9miLjiJ8nCgYnhRHJvNr29J_k0DG8pqQuio,921
-moreniius-0.5.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-moreniius-0.5.2.dist-info/entry_points.txt,sha256=Ga3k4P4fyBt5_dJ03Oapic2Qlgqv9jufQGdxWiz_j2A,63
-moreniius-0.5.2.dist-info/top_level.txt,sha256=RzMo23UfVhgQeuOYeS5P9I0qVbxx4Gbe6Roc29Mr02c,10
-moreniius-0.5.2.dist-info/RECORD,,
+moreniius-0.6.1.dist-info/METADATA,sha256=ebjFHY4-LTTdtCnv5Y03-VWOme6vrOYSZHz4pQKU0pg,946
+moreniius-0.6.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+moreniius-0.6.1.dist-info/entry_points.txt,sha256=Ga3k4P4fyBt5_dJ03Oapic2Qlgqv9jufQGdxWiz_j2A,63
+moreniius-0.6.1.dist-info/top_level.txt,sha256=RzMo23UfVhgQeuOYeS5P9I0qVbxx4Gbe6Roc29Mr02c,10
+moreniius-0.6.1.dist-info/RECORD,,