easyreflectometry 1.1.0__tar.gz → 1.2.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.
Files changed (59) hide show
  1. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/PKG-INFO +4 -3
  2. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/pyproject.toml +4 -3
  3. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/__init__.py +7 -0
  4. easyreflectometry-1.2.0/src/easyreflectometry/__version__.py +1 -0
  5. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/calculators/bornagain/calculator.py +1 -21
  6. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/calculators/calculator_base.py +3 -3
  7. easyreflectometry-1.2.0/src/easyreflectometry/calculators/factory.py +37 -0
  8. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/calculators/refl1d/wrapper.py +1 -1
  9. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/calculators/refnx/wrapper.py +1 -1
  10. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/calculators/wrapper_base.py +2 -2
  11. easyreflectometry-1.2.0/src/easyreflectometry/data/__init__.py +11 -0
  12. easyreflectometry-1.2.0/src/easyreflectometry/data/data_store.py +140 -0
  13. easyreflectometry-1.1.0/src/easyreflectometry/data.py → easyreflectometry-1.2.0/src/easyreflectometry/data/measurement.py +13 -0
  14. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/fitting.py +18 -7
  15. {easyreflectometry-1.1.0/src/easyreflectometry/experiment → easyreflectometry-1.2.0/src/easyreflectometry/model}/model.py +38 -39
  16. {easyreflectometry-1.1.0/src/easyreflectometry/experiment → easyreflectometry-1.2.0/src/easyreflectometry/model}/model_collection.py +25 -23
  17. {easyreflectometry-1.1.0/src/easyreflectometry/experiment → easyreflectometry-1.2.0/src/easyreflectometry/model}/resolution_functions.py +13 -7
  18. easyreflectometry-1.2.0/src/easyreflectometry/project.py +452 -0
  19. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/__init__.py +3 -3
  20. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/assemblies/base_assembly.py +2 -2
  21. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/assemblies/gradient_layer.py +4 -2
  22. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/assemblies/multilayer.py +4 -10
  23. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/assemblies/repeating_multilayer.py +3 -4
  24. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/assemblies/surfactant_layer.py +35 -6
  25. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/base_core.py +1 -1
  26. easyreflectometry-1.2.0/src/easyreflectometry/sample/collections/base_collection.py +95 -0
  27. easyreflectometry-1.2.0/src/easyreflectometry/sample/collections/layer_collection.py +44 -0
  28. easyreflectometry-1.2.0/src/easyreflectometry/sample/collections/material_collection.py +60 -0
  29. easyreflectometry-1.2.0/src/easyreflectometry/sample/collections/sample.py +155 -0
  30. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/elements/layers/layer.py +1 -1
  31. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/elements/layers/layer_area_per_molecule.py +18 -11
  32. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/elements/materials/material.py +8 -2
  33. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/elements/materials/material_density.py +2 -2
  34. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/elements/materials/material_mixture.py +6 -6
  35. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/sample/elements/materials/material_solvated.py +5 -5
  36. easyreflectometry-1.2.0/src/easyreflectometry/summary/__init__.py +3 -0
  37. easyreflectometry-1.2.0/src/easyreflectometry/summary/html_templates.py +149 -0
  38. easyreflectometry-1.2.0/src/easyreflectometry/summary/summary.py +194 -0
  39. easyreflectometry-1.1.0/src/easyreflectometry/parameter_utils.py → easyreflectometry-1.2.0/src/easyreflectometry/utils.py +31 -0
  40. easyreflectometry-1.1.0/src/easyreflectometry/__version__.py +0 -1
  41. easyreflectometry-1.1.0/src/easyreflectometry/calculators/factory.py +0 -16
  42. easyreflectometry-1.1.0/src/easyreflectometry/measurement/data.py +0 -11
  43. easyreflectometry-1.1.0/src/easyreflectometry/sample/base_element_collection.py +0 -56
  44. easyreflectometry-1.1.0/src/easyreflectometry/sample/elements/layers/layer_collection.py +0 -23
  45. easyreflectometry-1.1.0/src/easyreflectometry/sample/elements/materials/material_collection.py +0 -28
  46. easyreflectometry-1.1.0/src/easyreflectometry/sample/sample.py +0 -77
  47. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/.gitignore +0 -0
  48. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/AUTHORS.rst +0 -0
  49. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/LICENSE +0 -0
  50. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/README.md +0 -0
  51. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/calculators/__init__.py +0 -0
  52. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/calculators/bornagain/wrapper.py +0 -0
  53. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/calculators/refl1d/calculator.py +0 -0
  54. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/calculators/refnx/calculator.py +0 -0
  55. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/main.py +0 -0
  56. {easyreflectometry-1.1.0/src/easyreflectometry/experiment → easyreflectometry-1.2.0/src/easyreflectometry/model}/__init__.py +0 -0
  57. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/plot.py +0 -0
  58. {easyreflectometry-1.1.0 → easyreflectometry-1.2.0}/src/easyreflectometry/special/calculations.py +0 -0
  59. {easyreflectometry-1.1.0 → easyreflectometry-1.2.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.1.0
3
+ Version: 1.2.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
@@ -46,13 +46,14 @@ Classifier: Programming Language :: Python :: 3.10
46
46
  Classifier: Programming Language :: Python :: 3.11
47
47
  Classifier: Programming Language :: Python :: 3.12
48
48
  Classifier: Topic :: Scientific/Engineering
49
- Requires-Python: <3.12,>=3.9
50
- Requires-Dist: easyscience>=1.0.1
49
+ Requires-Python: <3.13,>=3.9
50
+ Requires-Dist: easyscience>=1.2.0
51
51
  Requires-Dist: orsopy>=0.0.4
52
52
  Requires-Dist: pint==0.23
53
53
  Requires-Dist: refl1d>=0.8.14
54
54
  Requires-Dist: refnx>=0.1.15
55
55
  Requires-Dist: scipp>=23.12.0
56
+ Requires-Dist: xhtml2pdf>=0.2.16
56
57
  Provides-Extra: dev
57
58
  Requires-Dist: build; extra == 'dev'
58
59
  Requires-Dist: codecov>=2.1.11; extra == 'dev'
@@ -27,14 +27,15 @@ classifiers = [
27
27
  "Programming Language :: Python :: 3.12",
28
28
  "Development Status :: 3 - Alpha"
29
29
  ]
30
- requires-python = ">=3.9,<3.12"
30
+ requires-python = ">=3.9,<3.13"
31
31
  dependencies = [
32
- "easyscience>=1.0.1",
32
+ "easyscience>=1.2.0",
33
33
  "scipp>=23.12.0",
34
34
  "refnx>=0.1.15",
35
35
  "refl1d>=0.8.14",
36
36
  "orsopy>=0.0.4",
37
- "pint==0.23" # Only to ensure that unit is reported as dimensionless rather than empty string
37
+ "pint==0.23", # Only to ensure that unit is reported as dimensionless rather than empty string
38
+ "xhtml2pdf>=0.2.16"
38
39
  ]
39
40
 
40
41
  [project.optional-dependencies]
@@ -1,6 +1,13 @@
1
1
  from importlib import metadata
2
2
 
3
+ from .project import Project
4
+
3
5
  try:
4
6
  __version__ = metadata.version(__package__ or __name__)
5
7
  except metadata.PackageNotFoundError:
6
8
  __version__ = '0.0.0'
9
+
10
+ __all__ = [
11
+ Project,
12
+ __version__,
13
+ ]
@@ -0,0 +1 @@
1
+ __version__ = '1.2.0'
@@ -1,9 +1,8 @@
1
1
  __author__ = 'github.com/arm61'
2
2
 
3
- import numpy as np
4
3
  from easyscience.Objects.Inferface import ItemContainer
5
4
 
6
- from easyreflectometry.experiment import Model
5
+ from easyreflectometry.model import Model
7
6
  from easyreflectometry.sample import Layer
8
7
  from easyreflectometry.sample import Material
9
8
  from easyreflectometry.sample import MaterialMixture
@@ -180,22 +179,3 @@ class BornAgain(CalculatorBase):
180
179
  :type layer_id: int
181
180
  """
182
181
  self._wrapper.remove_item(item_id)
183
-
184
- def fit_func(self, x_array: np.ndarray) -> np.ndarray:
185
- """
186
- Function to perform a fit
187
- :param x_array: points to be calculated at
188
- :type x_array: np.ndarray
189
- :return: calculated points
190
- :rtype: np.ndarray
191
- """
192
- return self._wrapper.calculate(x_array)
193
-
194
- def sld_profile(self) -> tuple([np.ndarray, np.ndarray]):
195
- """
196
- Return the scattering length density profile.
197
-
198
- :return: z and sld(z)
199
- :rtype: tuple[np.ndarray, np.ndarray]
200
- """
201
- return self._wrapper.sld_profile()
@@ -7,7 +7,7 @@ import numpy as np
7
7
  from easyscience.Objects.core import ComponentSerializer
8
8
  from easyscience.Objects.Inferface import ItemContainer
9
9
 
10
- from easyreflectometry.experiment import Model
10
+ from easyreflectometry.model import Model
11
11
  from easyreflectometry.sample import BaseAssembly
12
12
  from easyreflectometry.sample import Layer
13
13
  from easyreflectometry.sample import Material
@@ -158,8 +158,8 @@ class CalculatorBase(ComponentSerializer, metaclass=ABCMeta):
158
158
  """
159
159
  self._wrapper.remove_item(item_id, model_id)
160
160
 
161
- def fit_func(self, x_array: np.ndarray, model_id: str) -> np.ndarray:
162
- """Function to perform a fit.
161
+ def reflectity_profile(self, x_array: np.ndarray, model_id: str) -> np.ndarray:
162
+ """Determines the reflectivity profile for the given range and model.
163
163
 
164
164
  :param x_array: points to be calculated at
165
165
  :param model_id: The model id
@@ -0,0 +1,37 @@
1
+ __author__ = 'github.com/wardsimon'
2
+ from typing import Callable
3
+
4
+ from easyscience.Objects.Inferface import InterfaceFactoryTemplate
5
+
6
+ from easyreflectometry.calculators import CalculatorBase
7
+
8
+
9
+ class CalculatorFactory(InterfaceFactoryTemplate):
10
+ def __init__(self):
11
+ super().__init__(interface_list=CalculatorBase._calculators)
12
+
13
+ def reset_storage(self) -> None:
14
+ return self().reset_storage()
15
+
16
+ def sld_profile(self, model_id: str) -> tuple:
17
+ return self().sld_profile(model_id)
18
+
19
+ @property
20
+ def fit_func(self) -> Callable:
21
+ """
22
+ Pass through to the underlying interfaces fitting function.
23
+
24
+ :param x_array: points to be calculated at
25
+ :type x_array: np.ndarray
26
+ :param args: positional arguments for the fitting function
27
+ :type args: Any
28
+ :param kwargs: key/value pair arguments for the fitting function.
29
+ :type kwargs: Any
30
+ :return: points calculated at positional values `x`
31
+ :rtype: np.ndarray
32
+ #"""
33
+
34
+ def __fit_func(*args, **kwargs):
35
+ return self().reflectity_profile(*args, **kwargs)
36
+
37
+ return __fit_func
@@ -6,7 +6,7 @@ import numpy as np
6
6
  from refl1d import model
7
7
  from refl1d import names
8
8
 
9
- from easyreflectometry.experiment.resolution_functions import PercentageFhwm
9
+ from easyreflectometry.model import PercentageFhwm
10
10
 
11
11
  from ..wrapper_base import WrapperBase
12
12
 
@@ -5,7 +5,7 @@ from typing import Tuple
5
5
  import numpy as np
6
6
  from refnx import reflect
7
7
 
8
- from easyreflectometry.experiment.resolution_functions import PercentageFhwm
8
+ from easyreflectometry.model import PercentageFhwm
9
9
 
10
10
  from ..wrapper_base import WrapperBase
11
11
 
@@ -2,8 +2,8 @@ from abc import abstractmethod
2
2
 
3
3
  import numpy as np
4
4
 
5
- from easyreflectometry.experiment import PercentageFhwm
6
- from easyreflectometry.experiment import ResolutionFunction
5
+ from easyreflectometry.model import PercentageFhwm
6
+ from easyreflectometry.model import ResolutionFunction
7
7
 
8
8
 
9
9
  class WrapperBase:
@@ -0,0 +1,11 @@
1
+ from .data_store import DataSet1D
2
+ from .data_store import ProjectData
3
+ from .measurement import load
4
+ from .measurement import load_as_dataset
5
+
6
+ __all__ = [
7
+ load,
8
+ load_as_dataset,
9
+ ProjectData,
10
+ DataSet1D,
11
+ ]
@@ -0,0 +1,140 @@
1
+ __author__ = 'github.com/wardsimon'
2
+
3
+ from collections.abc import Sequence
4
+ from typing import Optional
5
+ from typing import TypeVar
6
+ from typing import Union
7
+
8
+ import numpy as np
9
+ from easyscience.Objects.core import ComponentSerializer
10
+ from easyscience.Utils.io.dict import DictSerializer
11
+
12
+ from easyreflectometry.model import Model
13
+
14
+ T = TypeVar('T')
15
+
16
+
17
+ class ProjectData(ComponentSerializer):
18
+ def __init__(self, name='DataStore', exp_data=None, sim_data=None):
19
+ self.name = name
20
+ if exp_data is None:
21
+ exp_data = DataStore(name='Exp Datastore')
22
+ if sim_data is None:
23
+ sim_data = DataStore(name='Sim Datastore')
24
+ self.exp_data = exp_data
25
+ self.sim_data = sim_data
26
+
27
+
28
+ class DataStore(Sequence, ComponentSerializer):
29
+ def __init__(self, *args, name='DataStore'):
30
+ self.name = name
31
+ self.items = list(args)
32
+ self.show_legend = False
33
+
34
+ def __getitem__(self, i: int) -> T:
35
+ return self.items.__getitem__(i)
36
+
37
+ def __len__(self) -> int:
38
+ return len(self.items)
39
+
40
+ def __setitem__(self, key, value):
41
+ self.items[key] = value
42
+
43
+ def __delitem__(self, key):
44
+ del self.items[key]
45
+
46
+ def append(self, *args):
47
+ self.items.append(*args)
48
+
49
+ def as_dict(self, skip: list = []) -> dict:
50
+ this_dict = super(DataStore, self).as_dict(self, skip=skip)
51
+ this_dict['items'] = [item.as_dict() for item in self.items if hasattr(item, 'as_dict')]
52
+
53
+ @classmethod
54
+ def from_dict(cls, d):
55
+ items = d['items']
56
+ del d['items']
57
+ obj = cls.from_dict(d)
58
+ decoder = DictSerializer()
59
+ obj.items = [decoder.decode(item) for item in items]
60
+ return obj
61
+
62
+ @property
63
+ def experiments(self):
64
+ return [self[idx] for idx in range(len(self)) if self[idx].is_experiment]
65
+
66
+ @property
67
+ def simulations(self):
68
+ return [self[idx] for idx in range(len(self)) if self[idx].is_simulation]
69
+
70
+
71
+ class DataSet1D(ComponentSerializer):
72
+ def __init__(
73
+ self,
74
+ name: str = 'Series',
75
+ x: Optional[Union[np.ndarray, list]] = None,
76
+ y: Optional[Union[np.ndarray, list]] = None,
77
+ ye: Optional[Union[np.ndarray, list]] = None,
78
+ xe: Optional[Union[np.ndarray, list]] = None,
79
+ model: Optional[Model] = None,
80
+ x_label: str = 'x',
81
+ y_label: str = 'y',
82
+ ):
83
+ self._model = model
84
+ if y is not None and model is not None:
85
+ self._model.background = np.min(y)
86
+
87
+ if x is None:
88
+ x = np.array([])
89
+ if y is None:
90
+ y = np.array([])
91
+ if ye is None:
92
+ ye = np.zeros_like(x)
93
+ if xe is None:
94
+ xe = np.zeros_like(x)
95
+
96
+ if len(x) != len(y):
97
+ raise ValueError('x and y must be the same length')
98
+
99
+ self.name = name
100
+ if not isinstance(x, np.ndarray):
101
+ x = np.array(x)
102
+ if not isinstance(y, np.ndarray):
103
+ y = np.array(y)
104
+ if not isinstance(ye, np.ndarray):
105
+ ye = np.array(ye)
106
+ if not isinstance(xe, np.ndarray):
107
+ xe = np.array(xe)
108
+
109
+ self.x = x
110
+ self.y = y
111
+ self.ye = ye
112
+ self.xe = xe
113
+
114
+ self.x_label = x_label
115
+ self.y_label = y_label
116
+
117
+ self._color = None
118
+
119
+ @property
120
+ def model(self) -> Model:
121
+ return self._model
122
+
123
+ @model.setter
124
+ def model(self, new_model: Model) -> None:
125
+ self._model = new_model
126
+ self._model.background = np.min(self.y)
127
+
128
+ @property
129
+ def is_experiment(self) -> bool:
130
+ return self._model is not None
131
+
132
+ @property
133
+ def is_simulation(self) -> bool:
134
+ return self._model is None
135
+
136
+ def data_points(self) -> tuple[float, float, float, float]:
137
+ return zip(self.x, self.y, self.ye, self.xe)
138
+
139
+ def __repr__(self) -> str:
140
+ return "1D DataStore of '{:s}' Vs '{:s}' with {} data points".format(self.x_label, self.y_label, len(self.x))
@@ -8,6 +8,19 @@ import scipp as sc
8
8
  from orsopy.fileio import Header
9
9
  from orsopy.fileio import orso
10
10
 
11
+ from easyreflectometry.data import DataSet1D
12
+
13
+
14
+ def load_as_dataset(fname: Union[TextIO, str]) -> DataSet1D:
15
+ """Load data from an ORSO .ort file as a DataSet1D."""
16
+ data_group = load(fname)
17
+ return DataSet1D(
18
+ x=data_group['coords']['Qz_0'].values,
19
+ y=data_group['data']['R_0'].values,
20
+ ye=data_group['data']['R_0'].variances,
21
+ xe=data_group['coords']['Qz_0'].variances,
22
+ )
23
+
11
24
 
12
25
  def load(fname: Union[TextIO, str]) -> sc.DataGroup:
13
26
  """Load data from an ORSO .ort file.
@@ -3,12 +3,14 @@ __author__ = 'github.com/arm61'
3
3
  import numpy as np
4
4
  import scipp as sc
5
5
  from easyscience.fitting import AvailableMinimizers
6
- from easyscience.fitting.multi_fitter import MultiFitter as easyFitter
6
+ from easyscience.fitting import FitResults
7
+ from easyscience.fitting.multi_fitter import MultiFitter as EasyScienceMultiFitter
7
8
 
8
- from easyreflectometry.experiment import Model
9
+ from easyreflectometry.data import DataSet1D
10
+ from easyreflectometry.model import Model
9
11
 
10
12
 
11
- class Fitter:
13
+ class MultiFitter:
12
14
  def __init__(self, *args: Model):
13
15
  r"""A convinence class for the :py:class:`easyscience.Fitting.Fitting`
14
16
  which will populate the :py:class:`sc.DataGroup` appropriately
@@ -26,7 +28,7 @@ class Fitter:
26
28
 
27
29
  self._fit_func = [func_wrapper(m.interface.fit_func, m.unique_name) for m in args]
28
30
  self._models = args
29
- self.easy_f = easyFitter(args, self._fit_func)
31
+ self.easy_science_multi_fitter = EasyScienceMultiFitter(args, self._fit_func)
30
32
 
31
33
  def fit(self, data: sc.DataGroup, id: int = 0) -> sc.DataGroup:
32
34
  """
@@ -39,14 +41,14 @@ class Fitter:
39
41
  x = [data['coords'][f'Qz_{i}'].values for i in refl_nums]
40
42
  y = [data['data'][f'R_{i}'].values for i in refl_nums]
41
43
  dy = [1 / np.sqrt(data['data'][f'R_{i}'].variances) for i in refl_nums]
42
- result = self.easy_f.fit(x, y, weights=dy)
44
+ result = self.easy_science_multi_fitter.fit(x, y, weights=dy)
43
45
  new_data = data.copy()
44
46
  for i, _ in enumerate(result):
45
47
  id = refl_nums[i]
46
48
  new_data[f'R_{id}_model'] = sc.array(
47
49
  dims=[f'Qz_{id}'], values=self._fit_func[i](data['coords'][f'Qz_{id}'].values)
48
50
  )
49
- sld_profile = self.easy_f._fit_objects[i].interface.sld_profile(self._models[i].unique_name)
51
+ sld_profile = self.easy_science_multi_fitter._fit_objects[i].interface.sld_profile(self._models[i].unique_name)
50
52
  new_data[f'SLD_{id}'] = sc.array(dims=[f'z_{id}'], values=sld_profile[1] * 1e-6, unit=sc.Unit('1/angstrom') ** 2)
51
53
  new_data['attrs'][f'R_{id}_model'] = {'model': sc.scalar(self._models[i].as_dict())}
52
54
  new_data['coords'][f'z_{id}'] = sc.array(
@@ -54,13 +56,22 @@ class Fitter:
54
56
  )
55
57
  return new_data
56
58
 
59
+ def fit_single_data_set_1d(self, data: DataSet1D) -> FitResults:
60
+ """
61
+ Perform the fitting and populate the DataGroups with the result.
62
+
63
+ :param data: DataGroup to be fitted to and populated
64
+ :param method: Optimisation method
65
+ """
66
+ return self.easy_science_multi_fitter.fit(x=[data.x], y=[data.y], weights=[data.ye])[0]
67
+
57
68
  def switch_minimizer(self, minimizer: AvailableMinimizers) -> None:
58
69
  """
59
70
  Switch the minimizer for the fitting.
60
71
 
61
72
  :param minimizer: Minimizer to be switched to
62
73
  """
63
- self.easy_f.switch_minimizer(minimizer)
74
+ self.easy_science_multi_fitter.switch_minimizer(minimizer)
64
75
 
65
76
 
66
77
  def _flatten_list(this_list: list) -> list:
@@ -4,18 +4,18 @@ __author__ = 'github.com/arm61'
4
4
 
5
5
  import copy
6
6
  from numbers import Number
7
+ from typing import Optional
7
8
  from typing import Union
8
9
 
9
10
  import numpy as np
11
+ from easyscience import global_object
10
12
  from easyscience.Objects.new_variable import Parameter
11
13
  from easyscience.Objects.ObjectClasses import BaseObj
12
14
 
13
- from easyreflectometry.parameter_utils import get_as_parameter
14
- from easyreflectometry.parameter_utils import yaml_dump
15
15
  from easyreflectometry.sample import BaseAssembly
16
- from easyreflectometry.sample import Layer
17
- from easyreflectometry.sample import LayerCollection
18
16
  from easyreflectometry.sample import Sample
17
+ from easyreflectometry.utils import get_as_parameter
18
+ from easyreflectometry.utils import yaml_dump
19
19
 
20
20
  from .resolution_functions import PercentageFhwm
21
21
  from .resolution_functions import ResolutionFunction
@@ -61,6 +61,8 @@ class Model(BaseObj):
61
61
  background: Union[Parameter, Number, None] = None,
62
62
  resolution_function: Union[ResolutionFunction, None] = None,
63
63
  name: str = 'EasyModel',
64
+ color: str = 'black',
65
+ unique_name: Optional[str] = None,
64
66
  interface=None,
65
67
  ):
66
68
  """Constructor.
@@ -73,6 +75,8 @@ class Model(BaseObj):
73
75
  :param interface: Calculator interface, defaults to `None`.
74
76
 
75
77
  """
78
+ if unique_name is None:
79
+ unique_name = global_object.generate_unique_name(self.__class__.__name__)
76
80
 
77
81
  if sample is None:
78
82
  sample = Sample(interface=interface)
@@ -81,62 +85,56 @@ class Model(BaseObj):
81
85
 
82
86
  scale = get_as_parameter('scale', scale, DEFAULTS)
83
87
  background = get_as_parameter('background', background, DEFAULTS)
88
+ self.color = color
84
89
 
85
90
  super().__init__(
86
91
  name=name,
92
+ unique_name=unique_name,
87
93
  sample=sample,
88
94
  scale=scale,
89
95
  background=background,
90
96
  )
91
97
  self.resolution_function = resolution_function
98
+
92
99
  # Must be set after resolution function
93
100
  self.interface = interface
94
101
 
95
- def add_item(self, *assemblies: list[BaseAssembly]) -> None:
96
- """Add a layer or item to the model sample.
102
+ def add_assemblies(self, *assemblies: list[BaseAssembly]) -> None:
103
+ """Add assemblies to the model sample.
97
104
 
98
105
  :param assemblies: Assemblies to add to model sample.
99
106
  """
100
- for arg in assemblies:
101
- if issubclass(arg.__class__, BaseAssembly):
102
- self.sample.append(arg)
103
- if self.interface is not None:
104
- self.interface().add_item_to_model(arg.unique_name, self.unique_name)
105
- else:
106
- raise ValueError(f'Object {arg} is not a valid type, must be a child of BaseAssembly.')
107
-
108
- def duplicate_item(self, idx: int) -> None:
107
+ if not assemblies:
108
+ self.sample.add_assembly()
109
+ if self.interface is not None:
110
+ self.interface().add_item_to_model(self.sample[-1].unique_name, self.unique_name)
111
+ else:
112
+ for assembly in assemblies:
113
+ if issubclass(assembly.__class__, BaseAssembly):
114
+ self.sample.add_assembly(assembly)
115
+ if self.interface is not None:
116
+ self.interface().add_item_to_model(self.sample[-1].unique_name, self.unique_name)
117
+ else:
118
+ raise ValueError(f'Object {assembly} is not a valid type, must be a child of BaseAssembly.')
119
+
120
+ def duplicate_assembly(self, index: int) -> None:
109
121
  """Duplicate a given item or layer in a sample.
110
122
 
111
123
  :param idx: Index of the item or layer to duplicate
112
124
  """
113
- to_duplicate = self.sample[idx]
114
- duplicate_layers = []
115
- for i in to_duplicate.layers:
116
- duplicate_layers.append(
117
- Layer(
118
- material=i.material,
119
- thickness=i.thickness.value,
120
- roughness=i.roughness.value,
121
- name=i.name + ' duplicate',
122
- interface=i.interface,
123
- )
124
- )
125
- duplicate = to_duplicate.__class__(
126
- LayerCollection(*duplicate_layers, name=to_duplicate.layers.name + ' duplicate'),
127
- name=to_duplicate.name + ' duplicate',
128
- )
129
- self.add_item(duplicate)
125
+ self.sample.duplicate_assembly(index)
126
+ if self.interface is not None:
127
+ self.interface().add_item_to_model(self.sample[-1].unique_name, self.unique_name)
130
128
 
131
- def remove_item(self, idx: int) -> None:
132
- """Remove an item from the model.
129
+ def remove_assembly(self, index: int) -> None:
130
+ """Remove an assembly from the model.
133
131
 
134
132
  :param idx: Index of the item to remove.
135
133
  """
136
- item_unique_name = self.sample[idx].unique_name
137
- del self.sample[idx]
134
+ assembly_unique_name = self.sample[index].unique_name
135
+ self.sample.remove_assembly(index)
138
136
  if self.interface is not None:
139
- self.interface().remove_item_from_model(item_unique_name, self.unique_name)
137
+ self.interface().remove_item_from_model(assembly_unique_name, self.unique_name)
140
138
 
141
139
  @property
142
140
  def resolution_function(self) -> ResolutionFunction:
@@ -181,6 +179,7 @@ class Model(BaseObj):
181
179
  'scale': float(self.scale.value),
182
180
  'background': float(self.background.value),
183
181
  'resolution': resolution,
182
+ 'color': self.color,
184
183
  'sample': self.sample._dict_repr,
185
184
  }
186
185
  }
@@ -189,7 +188,7 @@ class Model(BaseObj):
189
188
  """String representation of the layer."""
190
189
  return yaml_dump(self._dict_repr)
191
190
 
192
- def as_dict(self, skip: list = None) -> dict:
191
+ def as_dict(self, skip: Optional[list[str]] = None) -> dict:
193
192
  """Produces a cleaned dict using a custom as_dict method to skip necessary things.
194
193
  The resulting dict matches the parameters in __init__
195
194
 
@@ -200,7 +199,7 @@ class Model(BaseObj):
200
199
  skip.extend(['sample', 'resolution_function', 'interface'])
201
200
  this_dict = super().as_dict(skip=skip)
202
201
  this_dict['sample'] = self.sample.as_dict(skip=skip)
203
- this_dict['resolution_function'] = self.resolution_function.as_dict()
202
+ this_dict['resolution_function'] = self.resolution_function.as_dict(skip=skip)
204
203
  if self.interface is None:
205
204
  this_dict['interface'] = None
206
205
  else: