restage 0.5.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

restage/cache.py

@@ -107,24 +107,20 @@ def directory_under_module_data_path(sub: str, prefix=None, suffix=None, name=No
 
 def _compile_instr(entry: InstrEntry, instr: Instr, config: dict | None = None,
                    mpi: bool = False, acc: bool = False,
-                   target=None, generator=None):
-    from mccode_antlr import __version__
+                   target=None, flavor=None):
+    from mccode_antlr import __version__, Flavor
     from mccode_antlr.compiler.c import compile_instrument, CBinaryTarget
     if config is None:
         config = dict(default_main=True, enable_trace=False, portable=False, include_runtime=True,
                       embed_instrument_file=False, verbose=False)
     if target is None:
         target = CBinaryTarget(mpi=mpi or False, acc=acc or False, count=1, nexus=False)
-    if generator is None:
-        from mccode_antlr.translators.target import MCSTAS_GENERATOR
-        generator = MCSTAS_GENERATOR
+    if flavor is None:
+        flavor = Flavor.MCSTAS
 
     output = directory_under_module_data_path('bin')
-    # TODO consider adding `dump_source=True` _and_ putting the resulting file into
-    #      the cache in order to make debugging future problems a tiny bit easier.
-    # FIXME a future mccode-antlr will support setting 'source_file={file_path}'
-    #       to allow exactly this.
-    binary_path = compile_instrument(instr, target, output, generator=generator, config=config, dump_source=True)
+    source_file = output.joinpath(instr.name).with_suffix('.c')
+    binary_path = compile_instrument(instr, target, output, flavor=flavor, config=config, source_file=source_file)
     entry.mccode_version = __version__
     entry.binary_path = str(binary_path)
     return entry

restage/run.py

@@ -5,7 +5,7 @@ from .range import Singular
 
 def make_run_parser():
     from argparse import ArgumentParser
-    parser = ArgumentParser('mcbifrost_run')
+    parser = ArgumentParser('restage')
     parser.add_argument('primary', nargs=1, type=str, default=None,
                         help='Primary spectrometer `.instr` file name')
     parser.add_argument('secondary', nargs=1, type=str, default=None,

restage/tables.py

@@ -65,7 +65,7 @@ class SimulationEntry:
                     self.precision[k] = abs(self.precision[best[0]])
                 elif self.parameter_values[k].has_value:
                     # This abs is *crucial* since a negative parameter value would have a negative precision otherwise
-                    self.precision[k] = abs(self.parameter_values[k].value / 100)
+                    self.precision[k] = abs(self.parameter_values[k].value / 10000)
                 else:
                     log.info(f'SimulationEntry.__post_init__:: No precision match for value-less {k}, using 0.1;'
                              ' consider specifying precision dict during initialization')

{restage-0.5.1.dist-info → restage-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: restage
-Version: 0.5.1
+Version: 0.7.0
 Author-email: Gregory Tucker <gregory.tucker@ess.eu>
 License: BSD-3-Clause
 Classifier: License :: OSI Approved :: BSD License
@@ -17,7 +17,7 @@ Requires-Dist: zenlog>=1.1
 Requires-Dist: platformdirs>=3.11
 Requires-Dist: confuse
 Requires-Dist: psutil>=5.9.6
-Requires-Dist: mccode-antlr[hdf5]>=0.12.0
+Requires-Dist: mccode-antlr[hdf5]>=0.14.0
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: chopcal; extra == "test"
@@ -54,21 +54,21 @@ pip install git+https://github.com/g5t/restage.git
 ```
 
 ## Usage
-### `restage`
-The `restage` module provides a function, `restage`, which takes a McStas instrument file as input.
-The function will then parse the instrument file and generate new instrument files for the first and second stage simulations.
-The new instrument files will be named `restaged_lower_<original instrument file name>.instr`,
-and `restaged_upper_<original instrument file name>.instr`, respectively.
 
 ### `splitrun`
-A more useful function, `splitrun`, is also provided by the `restage` module.
-The `splitrun` function takes the same arguments as the `restage` function,
-but will also run the simulations for the first and second stage.
-The function will return the output of the second stage simulation.
-
-The `splitrun` function can be used as a replacement for the `mcrun` function distributed as part of McStas.
-One optional argument, `splitpoint`, is added to the `splitrun` function; it should be the name of
-an `Arm` component inside the instrument file and defaults to `split_at`.
+The `restage` module provides a command line program, `splitrun`, which
+can be used as a replacement for the `mcrun` function distributed as part of McStas.
+
+`splitrun` produces two instrument stages, before and after a split point, and runs
+the specified parameter set(s) in both stages connecting the two through cached MCPL
+state files.
+The first stage results are stored in a user cache directory and the second stage output
+is placed under the working directory following the McStas `mcrun` convention.
+
+Command line flags and parameters are mostly the same as used by `mcrun` with a number
+of additions to support `splitrun`'s enhanced behavior.
+One optional argument, `split-at`, is added; it should be the name of
+an `Arm` component inside the instrument file and defaults to `mcpl_split`.
 In contrast to `mcrun`, instrument parameters for `splitrun` are specified as 'MATLAB'-range style keyword arguments.
 A valid range is inclusive of its end points and of the form `start:step:end` or `start:end` (with implicit `step=1`).
 
@@ -103,7 +103,7 @@ mcrun my_instrument.instr -N 90 -n 1000000 -d /data/output sample_angle=1,90 sam
 ```
 can be replaced by the `splitrun` command
 ```bash
-splitrun my_instrument.instr -n 1000000 -d /data/output sample_angle=1:90 sample_radius=10.0
+splitrun my_instrument.instr -n 1000000 --split-at split_at -d /data/output sample_angle=1:90 sample_radius=10.0
 ```
 
 

{restage-0.5.1.dist-info → restage-0.7.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 restage/__init__.py,sha256=HlqvPpL7DKet00NAFyqJBNg9UFO7o05Gt2tFyKBQcsY,744
 restage/bifrost_choppers.py,sha256=xQu21g2NcTLPpZ0ZWOuvN20zh07EWoO4QVoTnoORwZI,6443
-restage/cache.py,sha256=PD07z9pxGwBcxoizgy11zoQBjViF1ZSzKS0686RZ3FI,8115
+restage/cache.py,sha256=Xep5j7jzq_qppp1i-KNSxZLpvyeZdDJkTMnB_PEE1gM,7824
 restage/cspec_choppers.py,sha256=ZWxyCcwYn4z9ZNqj_r6RC9ImbhVjYc1fmv-Ijm8A2Yk,206
 restage/database.py,sha256=anyOby31fUN7rGAVNsnWDUhAISV0vQ7en8aQwVS5ZwA,11051
 restage/emulate.py,sha256=VrhfZJIbECdbDS-MHklqRuAIy9cRkjZkwPBTKQSQoe0,6164
@@ -8,14 +8,14 @@ restage/energy.py,sha256=w78GUIWcHxANvBl2DTu73FQFawCXfzlK6L32TBQNt4g,3371
 restage/instr.py,sha256=A0ShtXkswt_f7o-cIDtsVbG03_tGELe1aS3WzLxzkJM,2494
 restage/mcpl.py,sha256=MKVY-2TYk5p8hW1lXJib5mxdbnILq4GoYiyAUgOBJmA,3269
 restage/range.py,sha256=TjOf4DSKfgoAIcrWQvv6MrtksQpnGJHdsEjVI5K-UfI,8116
-restage/run.py,sha256=nk8d7cIyIqSt-5pyGm68Zak5H1a-fbo_z2_36eN-08E,1481
+restage/run.py,sha256=bTcQIN9edKMXU_eFdX3E_mtJjwemoARrIUmZqzEGf0E,1475
 restage/scan.py,sha256=Yx8OQSBG6I2_64sW0LIDb0glVKwWoxUQQznASXgDZFQ,1432
 restage/splitrun.py,sha256=W_pTeiMjc9hhu-zaE6fdetVLG6MGEpnaTOdgmgVkS1g,26061
-restage/tables.py,sha256=mL1SrCbgwfWzG-ezd_R3CxOSIZLNZRoC2r7ht59jGMA,16371
+restage/tables.py,sha256=vQf0GkM7ojQbWee_P_Xqfx0-lXLym7x6kyam8CWpB5s,16373
 restage/config/__init__.py,sha256=zFRT9QXgpUJpBncELCQ6by1-kjYp8Li1yJDfqxkHxAA,965
 restage/config/default.yaml,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-restage-0.5.1.dist-info/METADATA,sha256=r51j8rWD3Iwc9y8D-ZWZL46JERjcgEkch-88CYeOt4w,6769
-restage-0.5.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-restage-0.5.1.dist-info/entry_points.txt,sha256=gghocSxC2gHHxUCalAibCN1mtkh3trNmAfH5Qwx0KYg,149
-restage-0.5.1.dist-info/top_level.txt,sha256=iM_pb-taTZ0S2WMoDnt_qDMZoNMjmM19z3tTCuVm1IE,8
-restage-0.5.1.dist-info/RECORD,,
+restage-0.7.0.dist-info/METADATA,sha256=VTicESA3b8fD__6eT-P_Upsx8Nb8AygdlMqT9K50PN8,6606
+restage-0.7.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+restage-0.7.0.dist-info/entry_points.txt,sha256=vYNOPxJ4PzG-1GGFSd08jFxhrtKUWAdWzjJQeFBzFJE,116
+restage-0.7.0.dist-info/top_level.txt,sha256=iM_pb-taTZ0S2WMoDnt_qDMZoNMjmM19z3tTCuVm1IE,8
+restage-0.7.0.dist-info/RECORD,,

{restage-0.5.1.dist-info → restage-0.7.0.dist-info}/entry_points.txt

@@ -1,4 +1,3 @@
 [console_scripts]
-restage = restage.run:entrypoint
 restage_bifrost_choppers = restage.bifrost_choppers:script
 splitrun = restage.splitrun:entrypoint