easyreflectometry 1.0.2__tar.gz → 1.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of easyreflectometry might be problematic. Click here for more details.
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/PKG-INFO +4 -2
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/pyproject.toml +5 -3
- easyreflectometry-1.1.0/src/easyreflectometry/__version__.py +1 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/calculators/bornagain/calculator.py +9 -8
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/calculators/calculator_base.py +21 -8
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/calculators/refl1d/wrapper.py +27 -13
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/calculators/refnx/wrapper.py +14 -1
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/calculators/wrapper_base.py +13 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/experiment/model.py +30 -19
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/experiment/model_collection.py +24 -4
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/fitting.py +17 -8
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/parameter_utils.py +24 -5
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/assemblies/base_assembly.py +8 -3
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/assemblies/gradient_layer.py +10 -8
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/assemblies/multilayer.py +16 -6
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/assemblies/repeating_multilayer.py +23 -4
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/assemblies/surfactant_layer.py +10 -6
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/base_core.py +3 -9
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/base_element_collection.py +3 -24
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/elements/layers/layer.py +26 -8
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/elements/layers/layer_area_per_molecule.py +52 -16
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/elements/layers/layer_collection.py +2 -3
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/elements/materials/material.py +24 -7
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/elements/materials/material_density.py +39 -29
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/elements/materials/material_mixture.py +41 -19
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/elements/materials/material_solvated.py +18 -6
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/sample.py +12 -29
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/special/calculations.py +4 -3
- easyreflectometry-1.0.2/src/easyreflectometry/__version__.py +0 -1
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/.gitignore +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/AUTHORS.rst +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/LICENSE +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/README.md +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/__init__.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/calculators/__init__.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/calculators/bornagain/wrapper.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/calculators/factory.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/calculators/refl1d/calculator.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/calculators/refnx/calculator.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/data.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/experiment/__init__.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/experiment/resolution_functions.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/main.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/measurement/data.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/plot.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/__init__.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/sample/elements/materials/material_collection.py +0 -0
- {easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/special/parsing.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: easyreflectometry
|
|
3
|
-
Version: 1.0
|
|
3
|
+
Version: 1.1.0
|
|
4
4
|
Summary: A reflectometry python package built on the EasyScience framework.
|
|
5
5
|
Project-URL: homepage, https://docs.easyreflectometry.org
|
|
6
6
|
Project-URL: documentation, https://docs.easyreflectometry.org
|
|
@@ -47,8 +47,9 @@ Classifier: Programming Language :: Python :: 3.11
|
|
|
47
47
|
Classifier: Programming Language :: Python :: 3.12
|
|
48
48
|
Classifier: Topic :: Scientific/Engineering
|
|
49
49
|
Requires-Python: <3.12,>=3.9
|
|
50
|
-
Requires-Dist: easyscience>=0.
|
|
50
|
+
Requires-Dist: easyscience>=1.0.1
|
|
51
51
|
Requires-Dist: orsopy>=0.0.4
|
|
52
|
+
Requires-Dist: pint==0.23
|
|
52
53
|
Requires-Dist: refl1d>=0.8.14
|
|
53
54
|
Requires-Dist: refnx>=0.1.15
|
|
54
55
|
Requires-Dist: scipp>=23.12.0
|
|
@@ -62,6 +63,7 @@ Requires-Dist: ipykernel; extra == 'dev'
|
|
|
62
63
|
Requires-Dist: jupyter>=1.0.0; extra == 'dev'
|
|
63
64
|
Requires-Dist: jupyterlab; extra == 'dev'
|
|
64
65
|
Requires-Dist: plopp; extra == 'dev'
|
|
66
|
+
Requires-Dist: pooch; extra == 'dev'
|
|
65
67
|
Requires-Dist: pytest-cov>=3.0.0; extra == 'dev'
|
|
66
68
|
Requires-Dist: pytest>=5.2; extra == 'dev'
|
|
67
69
|
Requires-Dist: ruff; extra == 'dev'
|
|
@@ -29,11 +29,12 @@ classifiers = [
|
|
|
29
29
|
]
|
|
30
30
|
requires-python = ">=3.9,<3.12"
|
|
31
31
|
dependencies = [
|
|
32
|
-
"easyscience>=0.
|
|
32
|
+
"easyscience>=1.0.1",
|
|
33
33
|
"scipp>=23.12.0",
|
|
34
34
|
"refnx>=0.1.15",
|
|
35
35
|
"refl1d>=0.8.14",
|
|
36
|
-
"orsopy>=0.0.4"
|
|
36
|
+
"orsopy>=0.0.4",
|
|
37
|
+
"pint==0.23" # Only to ensure that unit is reported as dimensionless rather than empty string
|
|
37
38
|
]
|
|
38
39
|
|
|
39
40
|
[project.optional-dependencies]
|
|
@@ -47,6 +48,7 @@ dev = [
|
|
|
47
48
|
"jupyter>=1.0.0",
|
|
48
49
|
"jupyterlab",
|
|
49
50
|
"plopp",
|
|
51
|
+
"pooch",
|
|
50
52
|
"pytest>=5.2",
|
|
51
53
|
"pytest-cov>=3.0.0",
|
|
52
54
|
"ruff",
|
|
@@ -94,7 +96,7 @@ exclude = [
|
|
|
94
96
|
[tool.ruff.format]
|
|
95
97
|
quote-style = "single"
|
|
96
98
|
|
|
97
|
-
[tool.ruff.per-file-ignores]
|
|
99
|
+
[tool.ruff.lint.per-file-ignores]
|
|
98
100
|
# allow asserts in test files
|
|
99
101
|
"*test_*.py" = ["S101"]
|
|
100
102
|
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = '1.1.0'
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
__author__ = 'github.com/arm61'
|
|
2
2
|
|
|
3
3
|
import numpy as np
|
|
4
|
+
from easyscience.Objects.Inferface import ItemContainer
|
|
5
|
+
|
|
4
6
|
from easyreflectometry.experiment import Model
|
|
5
7
|
from easyreflectometry.sample import Layer
|
|
6
8
|
from easyreflectometry.sample import Material
|
|
7
9
|
from easyreflectometry.sample import MaterialMixture
|
|
8
10
|
from easyreflectometry.sample import Multilayer
|
|
9
|
-
from easyscience.Objects.Inferface import ItemContainer
|
|
10
11
|
|
|
11
12
|
from ..calculator_base import CalculatorBase
|
|
12
13
|
from .wrapper import BornAgainWrapper
|
|
@@ -66,7 +67,7 @@ class BornAgain(CalculatorBase):
|
|
|
66
67
|
r_list = []
|
|
67
68
|
t_ = type(model)
|
|
68
69
|
if issubclass(t_, Material):
|
|
69
|
-
key = model.
|
|
70
|
+
key = model.unique_name
|
|
70
71
|
if key not in self._wrapper.storage['material'].keys():
|
|
71
72
|
self._wrapper.create_material(key)
|
|
72
73
|
r_list.append(
|
|
@@ -78,7 +79,7 @@ class BornAgain(CalculatorBase):
|
|
|
78
79
|
)
|
|
79
80
|
)
|
|
80
81
|
elif issubclass(t_, MaterialMixture):
|
|
81
|
-
key = model.
|
|
82
|
+
key = model.unique_name
|
|
82
83
|
if key not in self._wrapper.storage['material'].keys():
|
|
83
84
|
self._wrapper.create_material(key)
|
|
84
85
|
r_list.append(
|
|
@@ -90,7 +91,7 @@ class BornAgain(CalculatorBase):
|
|
|
90
91
|
)
|
|
91
92
|
)
|
|
92
93
|
elif issubclass(t_, Layer):
|
|
93
|
-
key = model.
|
|
94
|
+
key = model.unique_name
|
|
94
95
|
if key not in self._wrapper.storage['layer'].keys():
|
|
95
96
|
self._wrapper.create_layer(key)
|
|
96
97
|
r_list.append(
|
|
@@ -101,9 +102,9 @@ class BornAgain(CalculatorBase):
|
|
|
101
102
|
self._wrapper.update_layer,
|
|
102
103
|
)
|
|
103
104
|
)
|
|
104
|
-
self.assign_material_to_layer(model.material.
|
|
105
|
+
self.assign_material_to_layer(model.material.unique_name, key)
|
|
105
106
|
elif issubclass(t_, Multilayer):
|
|
106
|
-
key = model.
|
|
107
|
+
key = model.unique_name
|
|
107
108
|
self._wrapper.create_item(key)
|
|
108
109
|
r_list.append(
|
|
109
110
|
ItemContainer(
|
|
@@ -114,7 +115,7 @@ class BornAgain(CalculatorBase):
|
|
|
114
115
|
)
|
|
115
116
|
)
|
|
116
117
|
for i in model.layers:
|
|
117
|
-
self.add_layer_to_item(i.
|
|
118
|
+
self.add_layer_to_item(i.unique_name, model.unique_name)
|
|
118
119
|
elif issubclass(t_, Model):
|
|
119
120
|
self._wrapper.create_model()
|
|
120
121
|
r_list.append(
|
|
@@ -126,7 +127,7 @@ class BornAgain(CalculatorBase):
|
|
|
126
127
|
)
|
|
127
128
|
)
|
|
128
129
|
for i in model.structure:
|
|
129
|
-
self.add_item_to_model(i.
|
|
130
|
+
self.add_item_to_model(i.unique_name)
|
|
130
131
|
return r_list
|
|
131
132
|
|
|
132
133
|
def assign_material_to_layer(self, material_id: int, layer_id: int) -> None:
|
|
@@ -54,7 +54,7 @@ class CalculatorBase(ComponentSerializer, metaclass=ABCMeta):
|
|
|
54
54
|
r_list = []
|
|
55
55
|
t_ = type(model)
|
|
56
56
|
if issubclass(t_, Material):
|
|
57
|
-
key = model.
|
|
57
|
+
key = model.unique_name
|
|
58
58
|
if key not in self._wrapper.storage['material'].keys():
|
|
59
59
|
self._wrapper.create_material(key)
|
|
60
60
|
r_list.append(
|
|
@@ -66,7 +66,7 @@ class CalculatorBase(ComponentSerializer, metaclass=ABCMeta):
|
|
|
66
66
|
)
|
|
67
67
|
)
|
|
68
68
|
elif issubclass(t_, MaterialMixture):
|
|
69
|
-
key = model.
|
|
69
|
+
key = model.unique_name
|
|
70
70
|
if key not in self._wrapper.storage['material'].keys():
|
|
71
71
|
self._wrapper.create_material(key)
|
|
72
72
|
r_list.append(
|
|
@@ -78,7 +78,7 @@ class CalculatorBase(ComponentSerializer, metaclass=ABCMeta):
|
|
|
78
78
|
)
|
|
79
79
|
)
|
|
80
80
|
elif issubclass(t_, Layer):
|
|
81
|
-
key = model.
|
|
81
|
+
key = model.unique_name
|
|
82
82
|
if key not in self._wrapper.storage['layer'].keys():
|
|
83
83
|
self._wrapper.create_layer(key)
|
|
84
84
|
r_list.append(
|
|
@@ -89,9 +89,9 @@ class CalculatorBase(ComponentSerializer, metaclass=ABCMeta):
|
|
|
89
89
|
self._wrapper.update_layer,
|
|
90
90
|
)
|
|
91
91
|
)
|
|
92
|
-
self.assign_material_to_layer(model.material.
|
|
92
|
+
self.assign_material_to_layer(model.material.unique_name, key)
|
|
93
93
|
elif issubclass(t_, BaseAssembly):
|
|
94
|
-
key = model.
|
|
94
|
+
key = model.unique_name
|
|
95
95
|
self._wrapper.create_item(key)
|
|
96
96
|
r_list.append(
|
|
97
97
|
ItemContainer(
|
|
@@ -102,9 +102,9 @@ class CalculatorBase(ComponentSerializer, metaclass=ABCMeta):
|
|
|
102
102
|
)
|
|
103
103
|
)
|
|
104
104
|
for i in model.layers:
|
|
105
|
-
self.add_layer_to_item(i.
|
|
105
|
+
self.add_layer_to_item(i.unique_name, model.unique_name)
|
|
106
106
|
elif issubclass(t_, Model):
|
|
107
|
-
key = model.
|
|
107
|
+
key = model.unique_name
|
|
108
108
|
self._wrapper.create_model(key)
|
|
109
109
|
r_list.append(
|
|
110
110
|
ItemContainer(
|
|
@@ -115,7 +115,7 @@ class CalculatorBase(ComponentSerializer, metaclass=ABCMeta):
|
|
|
115
115
|
)
|
|
116
116
|
)
|
|
117
117
|
for i in model.sample:
|
|
118
|
-
self.add_item_to_model(i.
|
|
118
|
+
self.add_item_to_model(i.unique_name, key)
|
|
119
119
|
return r_list
|
|
120
120
|
|
|
121
121
|
def assign_material_to_layer(self, material_id: str, layer_id: str) -> None:
|
|
@@ -177,3 +177,16 @@ class CalculatorBase(ComponentSerializer, metaclass=ABCMeta):
|
|
|
177
177
|
|
|
178
178
|
def set_resolution_function(self, resolution_function: Callable[[np.array], np.array]) -> None:
|
|
179
179
|
return self._wrapper.set_resolution_function(resolution_function)
|
|
180
|
+
|
|
181
|
+
@property
|
|
182
|
+
def include_magnetism(self):
|
|
183
|
+
return self._wrapper.magnetism
|
|
184
|
+
|
|
185
|
+
@include_magnetism.setter
|
|
186
|
+
def include_magnetism(self, magnetism: bool):
|
|
187
|
+
"""
|
|
188
|
+
Set the magnetism flag for the calculator
|
|
189
|
+
|
|
190
|
+
:param magnetism: True if the calculator should include magnetism
|
|
191
|
+
"""
|
|
192
|
+
self._wrapper.magnetism = magnetism
|
|
@@ -3,15 +3,15 @@ __author__ = 'github.com/arm61'
|
|
|
3
3
|
from typing import Tuple
|
|
4
4
|
|
|
5
5
|
import numpy as np
|
|
6
|
-
from easyreflectometry.experiment.resolution_functions import PercentageFhwm
|
|
7
6
|
from refl1d import model
|
|
8
7
|
from refl1d import names
|
|
9
8
|
|
|
9
|
+
from easyreflectometry.experiment.resolution_functions import PercentageFhwm
|
|
10
|
+
|
|
10
11
|
from ..wrapper_base import WrapperBase
|
|
11
12
|
|
|
12
13
|
RESOLUTION_PADDING = 3.5
|
|
13
14
|
OVERSAMPLING_FACTOR = 21
|
|
14
|
-
MAGNETISM = False
|
|
15
15
|
ALL_POLARIZATIONS = False
|
|
16
16
|
|
|
17
17
|
|
|
@@ -30,8 +30,8 @@ class Refl1dWrapper(WrapperBase):
|
|
|
30
30
|
|
|
31
31
|
:param name: The name of the layer
|
|
32
32
|
"""
|
|
33
|
-
if
|
|
34
|
-
magnetism = names.Magnetism(rhoM=0.
|
|
33
|
+
if self._magnetism:
|
|
34
|
+
magnetism = names.Magnetism(rhoM=0.0, thetaM=0.0)
|
|
35
35
|
else:
|
|
36
36
|
magnetism = None
|
|
37
37
|
self.storage['layer'][name] = model.Slab(name=str(name), magnetism=magnetism)
|
|
@@ -47,17 +47,27 @@ class Refl1dWrapper(WrapperBase):
|
|
|
47
47
|
)
|
|
48
48
|
del self.storage['item'][name].stack[0]
|
|
49
49
|
|
|
50
|
-
def
|
|
50
|
+
def update_layer(self, name: str, **kwargs):
|
|
51
|
+
"""Update a layer in a given item.
|
|
52
|
+
|
|
53
|
+
:param name: The layer name.
|
|
54
|
+
:param kwargs:
|
|
51
55
|
"""
|
|
52
|
-
|
|
56
|
+
kwargs_no_magnetism = {k: v for k, v in kwargs.items() if k != 'magnetism_rhoM' and k != 'magnetism_thetaM'}
|
|
57
|
+
super().update_layer(name, **kwargs_no_magnetism)
|
|
58
|
+
if any(item.startswith('magnetism') for item in kwargs.keys()):
|
|
59
|
+
magnetism = names.Magnetism(rhoM=kwargs['magnetism_rhoM'], thetaM=kwargs['magnetism_thetaM'])
|
|
60
|
+
self.storage['layer'][name].magnetism = magnetism
|
|
53
61
|
|
|
54
|
-
|
|
62
|
+
def get_layer_value(self, name: str, key: str) -> float:
|
|
63
|
+
"""A function to get a given layer value
|
|
64
|
+
|
|
65
|
+
:param name: The layer name
|
|
55
66
|
:param key: The given value keys
|
|
56
|
-
:return: The desired value
|
|
57
67
|
"""
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
return
|
|
68
|
+
if key in ['magnetism_rhoM', 'magnetism_thetaM']:
|
|
69
|
+
return getattr(self.storage['layer'][name].magnetism, key.split('_')[-1])
|
|
70
|
+
return super().get_layer_value(name, key)
|
|
61
71
|
|
|
62
72
|
def create_model(self, name: str):
|
|
63
73
|
"""
|
|
@@ -151,7 +161,7 @@ class Refl1dWrapper(WrapperBase):
|
|
|
151
161
|
# Get percentage of Q and change from sigma to FWHM
|
|
152
162
|
dq_array = dq_array * q_array / 100 / (2 * np.sqrt(2 * np.log(2)))
|
|
153
163
|
|
|
154
|
-
if not
|
|
164
|
+
if not self._magnetism:
|
|
155
165
|
probe = _get_probe(
|
|
156
166
|
q_array=q_array,
|
|
157
167
|
dq_array=dq_array,
|
|
@@ -159,6 +169,7 @@ class Refl1dWrapper(WrapperBase):
|
|
|
159
169
|
storage=self.storage,
|
|
160
170
|
oversampling_factor=OVERSAMPLING_FACTOR,
|
|
161
171
|
)
|
|
172
|
+
# returns q, reflectivity
|
|
162
173
|
_, reflectivity = names.Experiment(probe=probe, sample=sample).reflectivity()
|
|
163
174
|
else:
|
|
164
175
|
polarized_probe = _get_polarized_probe(
|
|
@@ -173,11 +184,14 @@ class Refl1dWrapper(WrapperBase):
|
|
|
173
184
|
|
|
174
185
|
if ALL_POLARIZATIONS:
|
|
175
186
|
raise NotImplementedError('Polarized reflectivity not yet implemented')
|
|
187
|
+
# returns q, reflectivity
|
|
176
188
|
# _, reflectivity_pp = polarized_reflectivity[0]
|
|
177
189
|
# _, reflectivity_pm = polarized_reflectivity[1]
|
|
178
190
|
# _, reflectivity_mp = polarized_reflectivity[2]
|
|
179
191
|
# _, reflectivity_mm = polarized_reflectivity[3]
|
|
180
192
|
else:
|
|
193
|
+
# Only pick the pp reflectivity
|
|
194
|
+
# returns q, reflectivity
|
|
181
195
|
_, reflectivity = polarized_reflectivity[0]
|
|
182
196
|
|
|
183
197
|
return reflectivity
|
|
@@ -236,7 +250,7 @@ def _get_polarized_probe(
|
|
|
236
250
|
storage: dict,
|
|
237
251
|
oversampling_factor: int = 1,
|
|
238
252
|
all_polarizations: bool = False,
|
|
239
|
-
) -> names.
|
|
253
|
+
) -> names.PolarizedQProbe:
|
|
240
254
|
four_probes = []
|
|
241
255
|
for i in range(4):
|
|
242
256
|
if i == 0 or all_polarizations:
|
|
@@ -3,13 +3,26 @@ __author__ = 'github.com/arm61'
|
|
|
3
3
|
from typing import Tuple
|
|
4
4
|
|
|
5
5
|
import numpy as np
|
|
6
|
-
from easyreflectometry.experiment.resolution_functions import PercentageFhwm
|
|
7
6
|
from refnx import reflect
|
|
8
7
|
|
|
8
|
+
from easyreflectometry.experiment.resolution_functions import PercentageFhwm
|
|
9
|
+
|
|
9
10
|
from ..wrapper_base import WrapperBase
|
|
10
11
|
|
|
11
12
|
|
|
12
13
|
class RefnxWrapper(WrapperBase):
|
|
14
|
+
@property
|
|
15
|
+
def include_magnetism(self) -> bool:
|
|
16
|
+
return self._magnetism
|
|
17
|
+
|
|
18
|
+
@include_magnetism.setter
|
|
19
|
+
def include_magnetism(self, magnetism: bool) -> None:
|
|
20
|
+
"""Set the magnetism flag.
|
|
21
|
+
|
|
22
|
+
:param magnetism: The magnetism flag
|
|
23
|
+
"""
|
|
24
|
+
raise NotImplementedError('Magnetism is not supported by refnx')
|
|
25
|
+
|
|
13
26
|
def create_material(self, name: str):
|
|
14
27
|
"""
|
|
15
28
|
Create a material using SLD.
|
|
@@ -9,6 +9,7 @@ from easyreflectometry.experiment import ResolutionFunction
|
|
|
9
9
|
class WrapperBase:
|
|
10
10
|
def __init__(self):
|
|
11
11
|
"""Constructor."""
|
|
12
|
+
self._magnetism = False
|
|
12
13
|
self.storage = {
|
|
13
14
|
'material': {},
|
|
14
15
|
'layer': {},
|
|
@@ -210,3 +211,15 @@ class WrapperBase:
|
|
|
210
211
|
:param resolution_function: The resolution function
|
|
211
212
|
"""
|
|
212
213
|
self._resolution_function = resolution_function
|
|
214
|
+
|
|
215
|
+
@property
|
|
216
|
+
def magnetism(self) -> bool:
|
|
217
|
+
return self._magnetism
|
|
218
|
+
|
|
219
|
+
@magnetism.setter
|
|
220
|
+
def magnetism(self, magnetism: bool) -> None:
|
|
221
|
+
"""Set the magnetism flag.
|
|
222
|
+
|
|
223
|
+
:param magnetism: The magnetism flag
|
|
224
|
+
"""
|
|
225
|
+
self._magnetism = magnetism
|
{easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/experiment/model.py
RENAMED
|
@@ -2,15 +2,16 @@ from __future__ import annotations
|
|
|
2
2
|
|
|
3
3
|
__author__ = 'github.com/arm61'
|
|
4
4
|
|
|
5
|
+
import copy
|
|
5
6
|
from numbers import Number
|
|
6
7
|
from typing import Union
|
|
7
8
|
|
|
8
9
|
import numpy as np
|
|
9
|
-
import
|
|
10
|
+
from easyscience.Objects.new_variable import Parameter
|
|
10
11
|
from easyscience.Objects.ObjectClasses import BaseObj
|
|
11
|
-
from easyscience.Objects.ObjectClasses import Parameter
|
|
12
12
|
|
|
13
13
|
from easyreflectometry.parameter_utils import get_as_parameter
|
|
14
|
+
from easyreflectometry.parameter_utils import yaml_dump
|
|
14
15
|
from easyreflectometry.sample import BaseAssembly
|
|
15
16
|
from easyreflectometry.sample import Layer
|
|
16
17
|
from easyreflectometry.sample import LayerCollection
|
|
@@ -100,7 +101,7 @@ class Model(BaseObj):
|
|
|
100
101
|
if issubclass(arg.__class__, BaseAssembly):
|
|
101
102
|
self.sample.append(arg)
|
|
102
103
|
if self.interface is not None:
|
|
103
|
-
self.interface().add_item_to_model(arg.
|
|
104
|
+
self.interface().add_item_to_model(arg.unique_name, self.unique_name)
|
|
104
105
|
else:
|
|
105
106
|
raise ValueError(f'Object {arg} is not a valid type, must be a child of BaseAssembly.')
|
|
106
107
|
|
|
@@ -115,8 +116,8 @@ class Model(BaseObj):
|
|
|
115
116
|
duplicate_layers.append(
|
|
116
117
|
Layer(
|
|
117
118
|
material=i.material,
|
|
118
|
-
thickness=i.thickness.
|
|
119
|
-
roughness=i.roughness.
|
|
119
|
+
thickness=i.thickness.value,
|
|
120
|
+
roughness=i.roughness.value,
|
|
120
121
|
name=i.name + ' duplicate',
|
|
121
122
|
interface=i.interface,
|
|
122
123
|
)
|
|
@@ -132,9 +133,10 @@ class Model(BaseObj):
|
|
|
132
133
|
|
|
133
134
|
:param idx: Index of the item to remove.
|
|
134
135
|
"""
|
|
135
|
-
|
|
136
|
-
self.interface().remove_item_from_model(self.sample[idx].uid, self.uid)
|
|
136
|
+
item_unique_name = self.sample[idx].unique_name
|
|
137
137
|
del self.sample[idx]
|
|
138
|
+
if self.interface is not None:
|
|
139
|
+
self.interface().remove_item_from_model(item_unique_name, self.unique_name)
|
|
138
140
|
|
|
139
141
|
@property
|
|
140
142
|
def resolution_function(self) -> ResolutionFunction:
|
|
@@ -164,11 +166,6 @@ class Model(BaseObj):
|
|
|
164
166
|
self.generate_bindings()
|
|
165
167
|
self._interface().set_resolution_function(self._resolution_function)
|
|
166
168
|
|
|
167
|
-
@property
|
|
168
|
-
def uid(self) -> int:
|
|
169
|
-
"""Return a UID from the borg map."""
|
|
170
|
-
return self._borg.map.convert_id_to_key(self)
|
|
171
|
-
|
|
172
169
|
# Representation
|
|
173
170
|
@property
|
|
174
171
|
def _dict_repr(self) -> dict[str, dict[str, str]]:
|
|
@@ -181,8 +178,8 @@ class Model(BaseObj):
|
|
|
181
178
|
|
|
182
179
|
return {
|
|
183
180
|
self.name: {
|
|
184
|
-
'scale': self.scale.
|
|
185
|
-
'background': self.background.
|
|
181
|
+
'scale': float(self.scale.value),
|
|
182
|
+
'background': float(self.background.value),
|
|
186
183
|
'resolution': resolution,
|
|
187
184
|
'sample': self.sample._dict_repr,
|
|
188
185
|
}
|
|
@@ -190,7 +187,7 @@ class Model(BaseObj):
|
|
|
190
187
|
|
|
191
188
|
def __repr__(self) -> str:
|
|
192
189
|
"""String representation of the layer."""
|
|
193
|
-
return
|
|
190
|
+
return yaml_dump(self._dict_repr)
|
|
194
191
|
|
|
195
192
|
def as_dict(self, skip: list = None) -> dict:
|
|
196
193
|
"""Produces a cleaned dict using a custom as_dict method to skip necessary things.
|
|
@@ -200,26 +197,40 @@ class Model(BaseObj):
|
|
|
200
197
|
"""
|
|
201
198
|
if skip is None:
|
|
202
199
|
skip = []
|
|
200
|
+
skip.extend(['sample', 'resolution_function', 'interface'])
|
|
203
201
|
this_dict = super().as_dict(skip=skip)
|
|
204
202
|
this_dict['sample'] = self.sample.as_dict(skip=skip)
|
|
205
203
|
this_dict['resolution_function'] = self.resolution_function.as_dict()
|
|
204
|
+
if self.interface is None:
|
|
205
|
+
this_dict['interface'] = None
|
|
206
|
+
else:
|
|
207
|
+
this_dict['interface'] = self.interface().name
|
|
206
208
|
return this_dict
|
|
207
209
|
|
|
208
210
|
@classmethod
|
|
209
|
-
def from_dict(cls,
|
|
211
|
+
def from_dict(cls, passed_dict: dict) -> Model:
|
|
210
212
|
"""
|
|
211
213
|
Create a Model from a dictionary.
|
|
212
214
|
|
|
213
215
|
:param this_dict: dictionary of the Model
|
|
214
216
|
:return: Model
|
|
215
217
|
"""
|
|
218
|
+
# Causes circular import if imported at the top
|
|
219
|
+
from easyreflectometry.calculators import CalculatorFactory
|
|
220
|
+
|
|
221
|
+
this_dict = copy.deepcopy(passed_dict)
|
|
216
222
|
resolution_function = ResolutionFunction.from_dict(this_dict['resolution_function'])
|
|
217
223
|
del this_dict['resolution_function']
|
|
218
|
-
|
|
219
|
-
del this_dict['
|
|
224
|
+
interface_name = this_dict['interface']
|
|
225
|
+
del this_dict['interface']
|
|
226
|
+
if interface_name is not None:
|
|
227
|
+
interface = CalculatorFactory()
|
|
228
|
+
interface.switch(interface_name)
|
|
229
|
+
else:
|
|
230
|
+
interface = None
|
|
220
231
|
|
|
221
232
|
model = super().from_dict(this_dict)
|
|
222
233
|
|
|
223
|
-
model.sample = sample
|
|
224
234
|
model.resolution_function = resolution_function
|
|
235
|
+
model.interface = interface
|
|
225
236
|
return model
|
|
@@ -2,6 +2,7 @@ from __future__ import annotations
|
|
|
2
2
|
|
|
3
3
|
__author__ = 'github.com/arm61'
|
|
4
4
|
|
|
5
|
+
from typing import List
|
|
5
6
|
from typing import Optional
|
|
6
7
|
|
|
7
8
|
from easyreflectometry.sample.base_element_collection import SIZE_DEFAULT_COLLECTION
|
|
@@ -19,10 +20,18 @@ class ModelCollection(BaseElementCollection):
|
|
|
19
20
|
*models: Optional[tuple[Model]],
|
|
20
21
|
name: str = 'EasyModels',
|
|
21
22
|
interface=None,
|
|
23
|
+
populate_if_none: bool = True,
|
|
22
24
|
**kwargs,
|
|
23
25
|
):
|
|
24
26
|
if not models:
|
|
25
|
-
|
|
27
|
+
if populate_if_none:
|
|
28
|
+
models = [Model(interface=interface) for _ in range(SIZE_DEFAULT_COLLECTION)]
|
|
29
|
+
else:
|
|
30
|
+
models = []
|
|
31
|
+
# Needed to ensure an empty list is created when saving and instatiating the object as_dict -> from_dict
|
|
32
|
+
# Else collisions might occur in global_object.map
|
|
33
|
+
self.populate_if_none = False
|
|
34
|
+
|
|
26
35
|
super().__init__(name, interface, *models, **kwargs)
|
|
27
36
|
self.interface = interface
|
|
28
37
|
|
|
@@ -42,6 +51,11 @@ class ModelCollection(BaseElementCollection):
|
|
|
42
51
|
"""
|
|
43
52
|
del self[idx]
|
|
44
53
|
|
|
54
|
+
def as_dict(self, skip: List[str] | None = None) -> dict:
|
|
55
|
+
this_dict = super().as_dict(skip)
|
|
56
|
+
this_dict['populate_if_none'] = self.populate_if_none
|
|
57
|
+
return this_dict
|
|
58
|
+
|
|
45
59
|
@classmethod
|
|
46
60
|
def from_dict(cls, this_dict: dict) -> ModelCollection:
|
|
47
61
|
"""
|
|
@@ -50,11 +64,17 @@ class ModelCollection(BaseElementCollection):
|
|
|
50
64
|
:param data: The dictionary for the collection
|
|
51
65
|
:return: An instance of the collection
|
|
52
66
|
"""
|
|
53
|
-
|
|
67
|
+
collection_dict = this_dict.copy()
|
|
68
|
+
# We neeed to call from_dict on the base class to get the models
|
|
69
|
+
dict_data = collection_dict['data']
|
|
70
|
+
del collection_dict['data']
|
|
71
|
+
|
|
72
|
+
collection = super().from_dict(collection_dict) # type: ModelCollection
|
|
73
|
+
|
|
74
|
+
for model_data in dict_data:
|
|
75
|
+
collection.add_model(Model.from_dict(model_data))
|
|
54
76
|
|
|
55
77
|
if len(collection) != len(this_dict['data']):
|
|
56
78
|
raise ValueError(f"Expected {len(collection)} models, got {len(this_dict['data'])}")
|
|
57
|
-
for i, model_data in enumerate(this_dict['data']):
|
|
58
|
-
collection[i] = Model.from_dict(model_data)
|
|
59
79
|
|
|
60
80
|
return collection
|
|
@@ -2,7 +2,8 @@ __author__ = 'github.com/arm61'
|
|
|
2
2
|
|
|
3
3
|
import numpy as np
|
|
4
4
|
import scipp as sc
|
|
5
|
-
from easyscience.
|
|
5
|
+
from easyscience.fitting import AvailableMinimizers
|
|
6
|
+
from easyscience.fitting.multi_fitter import MultiFitter as easyFitter
|
|
6
7
|
|
|
7
8
|
from easyreflectometry.experiment import Model
|
|
8
9
|
|
|
@@ -16,18 +17,18 @@ class Fitter:
|
|
|
16
17
|
:param args: Reflectometry model
|
|
17
18
|
"""
|
|
18
19
|
|
|
19
|
-
# This lets the
|
|
20
|
-
def func_wrapper(func,
|
|
20
|
+
# This lets the unique_name be passed with the fit_func.
|
|
21
|
+
def func_wrapper(func, unique_name):
|
|
21
22
|
def wrapped(*args, **kwargs):
|
|
22
|
-
return func(*args,
|
|
23
|
+
return func(*args, unique_name, **kwargs)
|
|
23
24
|
|
|
24
25
|
return wrapped
|
|
25
26
|
|
|
26
|
-
self._fit_func = [func_wrapper(m.interface.fit_func, m.
|
|
27
|
+
self._fit_func = [func_wrapper(m.interface.fit_func, m.unique_name) for m in args]
|
|
27
28
|
self._models = args
|
|
28
29
|
self.easy_f = easyFitter(args, self._fit_func)
|
|
29
30
|
|
|
30
|
-
def fit(self, data: sc.DataGroup,
|
|
31
|
+
def fit(self, data: sc.DataGroup, id: int = 0) -> sc.DataGroup:
|
|
31
32
|
"""
|
|
32
33
|
Perform the fitting and populate the DataGroups with the result.
|
|
33
34
|
|
|
@@ -38,14 +39,14 @@ class Fitter:
|
|
|
38
39
|
x = [data['coords'][f'Qz_{i}'].values for i in refl_nums]
|
|
39
40
|
y = [data['data'][f'R_{i}'].values for i in refl_nums]
|
|
40
41
|
dy = [1 / np.sqrt(data['data'][f'R_{i}'].variances) for i in refl_nums]
|
|
41
|
-
result = self.easy_f.fit(x, y, weights=dy
|
|
42
|
+
result = self.easy_f.fit(x, y, weights=dy)
|
|
42
43
|
new_data = data.copy()
|
|
43
44
|
for i, _ in enumerate(result):
|
|
44
45
|
id = refl_nums[i]
|
|
45
46
|
new_data[f'R_{id}_model'] = sc.array(
|
|
46
47
|
dims=[f'Qz_{id}'], values=self._fit_func[i](data['coords'][f'Qz_{id}'].values)
|
|
47
48
|
)
|
|
48
|
-
sld_profile = self.easy_f._fit_objects[i].interface.sld_profile(self._models[i].
|
|
49
|
+
sld_profile = self.easy_f._fit_objects[i].interface.sld_profile(self._models[i].unique_name)
|
|
49
50
|
new_data[f'SLD_{id}'] = sc.array(dims=[f'z_{id}'], values=sld_profile[1] * 1e-6, unit=sc.Unit('1/angstrom') ** 2)
|
|
50
51
|
new_data['attrs'][f'R_{id}_model'] = {'model': sc.scalar(self._models[i].as_dict())}
|
|
51
52
|
new_data['coords'][f'z_{id}'] = sc.array(
|
|
@@ -53,6 +54,14 @@ class Fitter:
|
|
|
53
54
|
)
|
|
54
55
|
return new_data
|
|
55
56
|
|
|
57
|
+
def switch_minimizer(self, minimizer: AvailableMinimizers) -> None:
|
|
58
|
+
"""
|
|
59
|
+
Switch the minimizer for the fitting.
|
|
60
|
+
|
|
61
|
+
:param minimizer: Minimizer to be switched to
|
|
62
|
+
"""
|
|
63
|
+
self.easy_f.switch_minimizer(minimizer)
|
|
64
|
+
|
|
56
65
|
|
|
57
66
|
def _flatten_list(this_list: list) -> list:
|
|
58
67
|
"""
|
{easyreflectometry-1.0.2 → easyreflectometry-1.1.0}/src/easyreflectometry/parameter_utils.py
RENAMED
|
@@ -1,11 +1,19 @@
|
|
|
1
1
|
from copy import deepcopy
|
|
2
2
|
from numbers import Number
|
|
3
|
+
from typing import Optional
|
|
3
4
|
from typing import Union
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
import yaml
|
|
7
|
+
from easyscience import global_object
|
|
8
|
+
from easyscience.Objects.new_variable import Parameter
|
|
6
9
|
|
|
7
10
|
|
|
8
|
-
def get_as_parameter(
|
|
11
|
+
def get_as_parameter(
|
|
12
|
+
name: str,
|
|
13
|
+
value: Union[Parameter, Number, None],
|
|
14
|
+
default_dict: dict,
|
|
15
|
+
unique_name_prefix: Optional[str] = None,
|
|
16
|
+
) -> Parameter:
|
|
9
17
|
"""
|
|
10
18
|
This function creates a parameter for the variable `name`. A parameter has a value and metadata.
|
|
11
19
|
If the value already is a parameter, it is returned.
|
|
@@ -16,6 +24,10 @@ def get_as_parameter(name: str, value: Union[Parameter, Number, None], default_d
|
|
|
16
24
|
param name: The name of the parameter
|
|
17
25
|
param default_dict: Dictionary with entry for `name` containing the default value and metadata for the parameter
|
|
18
26
|
"""
|
|
27
|
+
# This is a parameter, return it
|
|
28
|
+
if isinstance(value, Parameter):
|
|
29
|
+
return value
|
|
30
|
+
|
|
19
31
|
# Ensure we got the dictionary for the parameter with the given name
|
|
20
32
|
# Should leave the passed dictionary unchanged
|
|
21
33
|
if name not in default_dict:
|
|
@@ -23,6 +35,10 @@ def get_as_parameter(name: str, value: Union[Parameter, Number, None], default_d
|
|
|
23
35
|
else:
|
|
24
36
|
parameter_dict = deepcopy(default_dict[name])
|
|
25
37
|
|
|
38
|
+
# Add specific unique name prefix if requested
|
|
39
|
+
if unique_name_prefix is not None:
|
|
40
|
+
parameter_dict['unique_name'] = global_object.generate_unique_name(unique_name_prefix + 'Parameter')
|
|
41
|
+
|
|
26
42
|
if value is None:
|
|
27
43
|
# Create a default parameter using both value and metadata from dictionary
|
|
28
44
|
return Parameter(name, **parameter_dict)
|
|
@@ -30,6 +46,9 @@ def get_as_parameter(name: str, value: Union[Parameter, Number, None], default_d
|
|
|
30
46
|
# Create a parameter using provided value and metadata from dictionary
|
|
31
47
|
del parameter_dict['value']
|
|
32
48
|
return Parameter(name, value, **parameter_dict)
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
49
|
+
|
|
50
|
+
raise ValueError(f'{name} must be a Parameter, a number, or None.')
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
def yaml_dump(dict_repr: dict) -> str:
|
|
54
|
+
return yaml.dump(dict_repr, sort_keys=False, allow_unicode=True)
|