restage 0.6.0__tar.gz → 0.7.0__tar.gz

{restage-0.6.0/src/restage.egg-info → restage-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: restage
-Version: 0.6.0
+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.13.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.6.0 → restage-0.7.0}/README.md

@@ -30,21 +30,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`).
 
@@ -79,7 +79,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.6.0 → restage-0.7.0}/pyproject.toml

@@ -9,7 +9,7 @@ dependencies = [
     'platformdirs>=3.11',
     'confuse',
     'psutil>=5.9.6',
-    'mccode-antlr[hdf5]>=0.13.0',
+    'mccode-antlr[hdf5]>=0.14.0',
 ]
 readme = "README.md"
 license = {text = "BSD-3-Clause"}
@@ -33,7 +33,6 @@ dynamic = ["version"]
 test = ["pytest", "chopcal"]
 
 [project.scripts]
-restage = "restage.run:entrypoint"
 splitrun = "restage.splitrun:entrypoint"
 restage_bifrost_choppers = "restage.bifrost_choppers:script"
 

{restage-0.6.0 → restage-0.7.0}/src/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-0.6.0 → restage-0.7.0}/src/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.6.0 → restage-0.7.0/src/restage.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: restage
-Version: 0.6.0
+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.13.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.6.0 → restage-0.7.0}/src/restage.egg-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

{restage-0.6.0 → restage-0.7.0}/src/restage.egg-info/requires.txt

@@ -2,7 +2,7 @@ zenlog>=1.1
 platformdirs>=3.11
 confuse
 psutil>=5.9.6
-mccode-antlr[hdf5]>=0.13.0
+mccode-antlr[hdf5]>=0.14.0
 
 [test]
 pytest

{restage-0.6.0 → restage-0.7.0}/test/test_single.py

@@ -148,12 +148,7 @@ class SplitRunTestCase(unittest.TestCase):
 
     def _define_instr(self):
         from math import pi, asin, sqrt
-        from mccode_antlr.reader import MCSTAS_REGISTRY
-        from mccode_antlr.loader.loader import parse_mccode_instr
-
-        def parse(contents):
-            registries = [MCSTAS_REGISTRY]
-            return parse_mccode_instr(contents, registries, '<test string>')
+        from mccode_antlr.loader.loader import parse_mcstas_instr
 
         d_spacing = 3.355  # (002) for Highly-ordered Pyrolytic Graphite
         mean_energy = 5.0
@@ -193,7 +188,7 @@ class SplitRunTestCase(unittest.TestCase):
         COMPONENT detector = Monitor(xwidth=0.01, yheight=0.05) AT (0, 0, 0.8) RELATIVE sample_arm
         END
         """
-        return parse(instr), min_a1, max_a1
+        return parse_mcstas_instr(instr), min_a1, max_a1
 
     def setUp(self) -> None:
         from pathlib import Path