From b517c24ba3af00f1172e5b756ac10499b2d010fa Mon Sep 17 00:00:00 2001 From: Andreas Pedersen Date: Mon, 6 May 2024 13:53:40 +0200 Subject: [PATCH] documentation moved to docs/src --- EasyReflectometry/calculators/refl1d/wrapper.py | 4 ++-- EasyReflectometry/calculators/refnx/wrapper.py | 4 ++-- EasyReflectometry/experiment/model.py | 4 ++-- .../experiment/resolution_functions.py | 2 +- docs/Makefile | 2 +- docs/make.bat | 2 +- docs/{ => src}/_static/favicon.ico | Bin docs/{ => src}/_static/logo.png | Bin docs/{ => src}/_static/logo.svg | 0 docs/{ => src}/api/api.rst | 0 docs/{ => src}/api/assemblies/gradient_layer.rst | 0 docs/{ => src}/api/assemblies/multilayer.rst | 0 .../api/assemblies/repeating_multilayer.rst | 0 docs/{ => src}/api/assemblies/surfactant_layer.rst | 0 docs/{ => src}/api/data.rst | 0 docs/{ => src}/api/elements/layer.rst | 0 .../api/elements/layer_area_per_molecule.rst | 0 docs/{ => src}/api/elements/material.rst | 0 docs/{ => src}/api/elements/material_density.rst | 0 docs/{ => src}/api/elements/material_mixture.rst | 0 docs/{ => src}/api/elements/material_solvated.rst | 0 docs/{ => src}/api/model.rst | 0 docs/{ => src}/api/sample.rst | 0 docs/{ => src}/authors.rst | 0 docs/{ => src}/calculators.rst | 0 docs/{ => src}/conf.py | 4 ++-- docs/{ => src}/contributing.rst | 0 docs/{ => src}/experiment/experiment.rst | 0 docs/{ => src}/index.rst | 0 docs/{ => src}/installation.rst | 0 docs/{ => src}/sample/assemblies_library.rst | 0 docs/{ => src}/sample/layer_library.rst | 0 docs/{ => src}/sample/material_library.rst | 0 docs/{ => src}/sample/sample.rst | 0 docs/{ => src}/tutorials/_static/d70d2o.ort | 0 docs/{ => src}/tutorials/_static/dspc.png | Bin docs/{ => src}/tutorials/_static/example.ort | 0 docs/{ => src}/tutorials/_static/monolayer.png | Bin docs/{ => src}/tutorials/_static/monolayer.svg | 0 docs/{ => src}/tutorials/_static/multiple.ort | 0 docs/{ => src}/tutorials/_static/polymer_film.png | Bin docs/{ => src}/tutorials/_static/polymer_film.svg | 0 docs/{ => src}/tutorials/_static/repeating.png | Bin docs/{ => src}/tutorials/_static/repeating.svg | 0 .../tutorials/_static/repeating_layers.ort | 0 .../mod_pointwise_two_layer_sample_dq-0.0.ort | 0 .../mod_pointwise_two_layer_sample_dq-1.0.ort | 0 .../mod_pointwise_two_layer_sample_dq-10.0.ort | 0 docs/{ => src}/tutorials/_static/two_layers.png | Bin docs/{ => src}/tutorials/_static/two_layers.svg | 0 docs/{ => src}/tutorials/material_solvated.ipynb | 4 ++-- docs/{ => src}/tutorials/monolayer.ipynb | 4 ++-- docs/{ => src}/tutorials/multi_contrast.ipynb | 4 ++-- docs/{ => src}/tutorials/repeating.ipynb | 4 ++-- docs/{ => src}/tutorials/resolution_functions.ipynb | 0 docs/{ => src}/tutorials/simple_fitting.ipynb | 4 ++-- docs/{ => src}/tutorials/tutorials.rst | 0 docs/{ => src}/usage.rst | 0 58 files changed, 21 insertions(+), 21 deletions(-) rename docs/{ => src}/_static/favicon.ico (100%) rename docs/{ => src}/_static/logo.png (100%) rename docs/{ => src}/_static/logo.svg (100%) rename docs/{ => src}/api/api.rst (100%) rename docs/{ => src}/api/assemblies/gradient_layer.rst (100%) rename docs/{ => src}/api/assemblies/multilayer.rst (100%) rename docs/{ => src}/api/assemblies/repeating_multilayer.rst (100%) rename docs/{ => src}/api/assemblies/surfactant_layer.rst (100%) rename docs/{ => src}/api/data.rst (100%) rename docs/{ => src}/api/elements/layer.rst (100%) rename docs/{ => src}/api/elements/layer_area_per_molecule.rst (100%) rename docs/{ => src}/api/elements/material.rst (100%) rename docs/{ => src}/api/elements/material_density.rst (100%) rename docs/{ => src}/api/elements/material_mixture.rst (100%) rename docs/{ => src}/api/elements/material_solvated.rst (100%) rename docs/{ => src}/api/model.rst (100%) rename docs/{ => src}/api/sample.rst (100%) rename docs/{ => src}/authors.rst (100%) rename docs/{ => src}/calculators.rst (100%) rename docs/{ => src}/conf.py (98%) mode change 100755 => 100644 rename docs/{ => src}/contributing.rst (100%) rename docs/{ => src}/experiment/experiment.rst (100%) rename docs/{ => src}/index.rst (100%) rename docs/{ => src}/installation.rst (100%) rename docs/{ => src}/sample/assemblies_library.rst (100%) rename docs/{ => src}/sample/layer_library.rst (100%) rename docs/{ => src}/sample/material_library.rst (100%) rename docs/{ => src}/sample/sample.rst (100%) rename docs/{ => src}/tutorials/_static/d70d2o.ort (100%) rename docs/{ => src}/tutorials/_static/dspc.png (100%) rename docs/{ => src}/tutorials/_static/example.ort (100%) rename docs/{ => src}/tutorials/_static/monolayer.png (100%) rename docs/{ => src}/tutorials/_static/monolayer.svg (100%) rename docs/{ => src}/tutorials/_static/multiple.ort (100%) rename docs/{ => src}/tutorials/_static/polymer_film.png (100%) rename docs/{ => src}/tutorials/_static/polymer_film.svg (100%) rename docs/{ => src}/tutorials/_static/repeating.png (100%) rename docs/{ => src}/tutorials/_static/repeating.svg (100%) rename docs/{ => src}/tutorials/_static/repeating_layers.ort (100%) rename docs/{ => src}/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-0.0.ort (100%) rename docs/{ => src}/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-1.0.ort (100%) rename docs/{ => src}/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-10.0.ort (100%) rename docs/{ => src}/tutorials/_static/two_layers.png (100%) rename docs/{ => src}/tutorials/_static/two_layers.svg (100%) rename docs/{ => src}/tutorials/material_solvated.ipynb (98%) rename docs/{ => src}/tutorials/monolayer.ipynb (99%) rename docs/{ => src}/tutorials/multi_contrast.ipynb (99%) rename docs/{ => src}/tutorials/repeating.ipynb (98%) rename docs/{ => src}/tutorials/resolution_functions.ipynb (100%) rename docs/{ => src}/tutorials/simple_fitting.ipynb (99%) rename docs/{ => src}/tutorials/tutorials.rst (100%) rename docs/{ => src}/usage.rst (100%) diff --git a/EasyReflectometry/calculators/refl1d/wrapper.py b/EasyReflectometry/calculators/refl1d/wrapper.py index ad704ada..fe1775ee 100644 --- a/EasyReflectometry/calculators/refl1d/wrapper.py +++ b/EasyReflectometry/calculators/refl1d/wrapper.py @@ -6,7 +6,7 @@ from refl1d import model from refl1d import names -from EasyReflectometry.experiment.resolution_functions import is_constant_resolution_function +from EasyReflectometry.experiment.resolution_functions import is_percentage_fhwm_resolution_function from ..wrapper_base import WrapperBase @@ -148,7 +148,7 @@ def calculate(self, q_array: np.ndarray, model_name: str) -> np.ndarray: sample = _build_sample(self.storage, model_name) dq_array = self._resolution_function(q_array) - if is_constant_resolution_function(self._resolution_function): + if is_percentage_fhwm_resolution_function(self._resolution_function): # Get percentage of Q and change from sigma to FWHM dq_array = dq_array * q_array / 100 / (2 * np.sqrt(2 * np.log(2))) diff --git a/EasyReflectometry/calculators/refnx/wrapper.py b/EasyReflectometry/calculators/refnx/wrapper.py index 5fce94a7..89ef92a3 100644 --- a/EasyReflectometry/calculators/refnx/wrapper.py +++ b/EasyReflectometry/calculators/refnx/wrapper.py @@ -5,7 +5,7 @@ import numpy as np from refnx import reflect -from EasyReflectometry.experiment.resolution_functions import is_constant_resolution_function +from EasyReflectometry.experiment.resolution_functions import is_percentage_fhwm_resolution_function from ..wrapper_base import WrapperBase @@ -131,7 +131,7 @@ def calculate(self, q_array: np.ndarray, model_name: str) -> np.ndarray: ) dq_vector = self._resolution_function(q_array) - if is_constant_resolution_function(self._resolution_function): + if is_percentage_fhwm_resolution_function(self._resolution_function): # FWHM Percentage resolution is constant given as # For a constant resolution percentage refnx supports to pass a scalar value rather than a vector dq_vector = dq_vector[0] diff --git a/EasyReflectometry/experiment/model.py b/EasyReflectometry/experiment/model.py index 0b2aa36c..9490c40d 100644 --- a/EasyReflectometry/experiment/model.py +++ b/EasyReflectometry/experiment/model.py @@ -11,7 +11,7 @@ from easyscience.Objects.ObjectClasses import BaseObj from easyscience.Objects.ObjectClasses import Parameter -from EasyReflectometry.experiment.resolution_functions import is_constant_resolution_function +from EasyReflectometry.experiment.resolution_functions import is_percentage_fhwm_resolution_function from EasyReflectometry.parameter_utils import get_as_parameter from EasyReflectometry.sample import BaseAssembly from EasyReflectometry.sample import Layer @@ -175,7 +175,7 @@ def uid(self) -> int: @property def _dict_repr(self) -> dict[str, dict[str, str]]: """A simplified dict representation.""" - if is_constant_resolution_function(self._resolution_function): + if is_percentage_fhwm_resolution_function(self._resolution_function): resolution_value = self._resolution_function([0])[0] resolution = f'{resolution_value} %' else: diff --git a/EasyReflectometry/experiment/resolution_functions.py b/EasyReflectometry/experiment/resolution_functions.py index a07a371b..fc0fa0ef 100644 --- a/EasyReflectometry/experiment/resolution_functions.py +++ b/EasyReflectometry/experiment/resolution_functions.py @@ -44,6 +44,6 @@ def _linear(q: np.array) -> np.array: return _linear -def is_constant_resolution_function(resolution_function: Callable[[np.array], np.array]) -> bool: +def is_percentage_fhwm_resolution_function(resolution_function: Callable[[np.array], np.array]) -> bool: """Check if the resolution function is a constant.""" return 'constant' in resolution_function.__name__ diff --git a/docs/Makefile b/docs/Makefile index 0766adbf..b7913396 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,7 +5,7 @@ SPHINXOPTS = SPHINXBUILD = python -msphinx SPHINXPROJ = EasyReflectometry -SOURCEDIR = . +SOURCEDIR = ./src BUILDDIR = _build # Put it first so that "make" without argument is like "make help". diff --git a/docs/make.bat b/docs/make.bat index 6e253da8..85009c8b 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -7,7 +7,7 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=python -msphinx ) -set SOURCEDIR=. +set SOURCEDIR=./src set BUILDDIR=_build set SPHINXPROJ=orsopy diff --git a/docs/_static/favicon.ico b/docs/src/_static/favicon.ico similarity index 100% rename from docs/_static/favicon.ico rename to docs/src/_static/favicon.ico diff --git a/docs/_static/logo.png b/docs/src/_static/logo.png similarity index 100% rename from docs/_static/logo.png rename to docs/src/_static/logo.png diff --git a/docs/_static/logo.svg b/docs/src/_static/logo.svg similarity index 100% rename from docs/_static/logo.svg rename to docs/src/_static/logo.svg diff --git a/docs/api/api.rst b/docs/src/api/api.rst similarity index 100% rename from docs/api/api.rst rename to docs/src/api/api.rst diff --git a/docs/api/assemblies/gradient_layer.rst b/docs/src/api/assemblies/gradient_layer.rst similarity index 100% rename from docs/api/assemblies/gradient_layer.rst rename to docs/src/api/assemblies/gradient_layer.rst diff --git a/docs/api/assemblies/multilayer.rst b/docs/src/api/assemblies/multilayer.rst similarity index 100% rename from docs/api/assemblies/multilayer.rst rename to docs/src/api/assemblies/multilayer.rst diff --git a/docs/api/assemblies/repeating_multilayer.rst b/docs/src/api/assemblies/repeating_multilayer.rst similarity index 100% rename from docs/api/assemblies/repeating_multilayer.rst rename to docs/src/api/assemblies/repeating_multilayer.rst diff --git a/docs/api/assemblies/surfactant_layer.rst b/docs/src/api/assemblies/surfactant_layer.rst similarity index 100% rename from docs/api/assemblies/surfactant_layer.rst rename to docs/src/api/assemblies/surfactant_layer.rst diff --git a/docs/api/data.rst b/docs/src/api/data.rst similarity index 100% rename from docs/api/data.rst rename to docs/src/api/data.rst diff --git a/docs/api/elements/layer.rst b/docs/src/api/elements/layer.rst similarity index 100% rename from docs/api/elements/layer.rst rename to docs/src/api/elements/layer.rst diff --git a/docs/api/elements/layer_area_per_molecule.rst b/docs/src/api/elements/layer_area_per_molecule.rst similarity index 100% rename from docs/api/elements/layer_area_per_molecule.rst rename to docs/src/api/elements/layer_area_per_molecule.rst diff --git a/docs/api/elements/material.rst b/docs/src/api/elements/material.rst similarity index 100% rename from docs/api/elements/material.rst rename to docs/src/api/elements/material.rst diff --git a/docs/api/elements/material_density.rst b/docs/src/api/elements/material_density.rst similarity index 100% rename from docs/api/elements/material_density.rst rename to docs/src/api/elements/material_density.rst diff --git a/docs/api/elements/material_mixture.rst b/docs/src/api/elements/material_mixture.rst similarity index 100% rename from docs/api/elements/material_mixture.rst rename to docs/src/api/elements/material_mixture.rst diff --git a/docs/api/elements/material_solvated.rst b/docs/src/api/elements/material_solvated.rst similarity index 100% rename from docs/api/elements/material_solvated.rst rename to docs/src/api/elements/material_solvated.rst diff --git a/docs/api/model.rst b/docs/src/api/model.rst similarity index 100% rename from docs/api/model.rst rename to docs/src/api/model.rst diff --git a/docs/api/sample.rst b/docs/src/api/sample.rst similarity index 100% rename from docs/api/sample.rst rename to docs/src/api/sample.rst diff --git a/docs/authors.rst b/docs/src/authors.rst similarity index 100% rename from docs/authors.rst rename to docs/src/authors.rst diff --git a/docs/calculators.rst b/docs/src/calculators.rst similarity index 100% rename from docs/calculators.rst rename to docs/src/calculators.rst diff --git a/docs/conf.py b/docs/src/conf.py old mode 100755 new mode 100644 similarity index 98% rename from docs/conf.py rename to docs/src/conf.py index 52e13033..1b4acd48 --- a/docs/conf.py +++ b/docs/src/conf.py @@ -23,9 +23,9 @@ import toml from pathlib import Path -sys.path.insert(0, os.path.abspath('..')) +sys.path.insert(0, os.path.abspath('../..')) -main_root = Path(__file__).parents[1] +main_root = Path(__file__).parents[2] sys.path.append(str(main_root)) project_info = toml.load(os.path.join(main_root, 'pyproject.toml')) diff --git a/docs/contributing.rst b/docs/src/contributing.rst similarity index 100% rename from docs/contributing.rst rename to docs/src/contributing.rst diff --git a/docs/experiment/experiment.rst b/docs/src/experiment/experiment.rst similarity index 100% rename from docs/experiment/experiment.rst rename to docs/src/experiment/experiment.rst diff --git a/docs/index.rst b/docs/src/index.rst similarity index 100% rename from docs/index.rst rename to docs/src/index.rst diff --git a/docs/installation.rst b/docs/src/installation.rst similarity index 100% rename from docs/installation.rst rename to docs/src/installation.rst diff --git a/docs/sample/assemblies_library.rst b/docs/src/sample/assemblies_library.rst similarity index 100% rename from docs/sample/assemblies_library.rst rename to docs/src/sample/assemblies_library.rst diff --git a/docs/sample/layer_library.rst b/docs/src/sample/layer_library.rst similarity index 100% rename from docs/sample/layer_library.rst rename to docs/src/sample/layer_library.rst diff --git a/docs/sample/material_library.rst b/docs/src/sample/material_library.rst similarity index 100% rename from docs/sample/material_library.rst rename to docs/src/sample/material_library.rst diff --git a/docs/sample/sample.rst b/docs/src/sample/sample.rst similarity index 100% rename from docs/sample/sample.rst rename to docs/src/sample/sample.rst diff --git a/docs/tutorials/_static/d70d2o.ort b/docs/src/tutorials/_static/d70d2o.ort similarity index 100% rename from docs/tutorials/_static/d70d2o.ort rename to docs/src/tutorials/_static/d70d2o.ort diff --git a/docs/tutorials/_static/dspc.png b/docs/src/tutorials/_static/dspc.png similarity index 100% rename from docs/tutorials/_static/dspc.png rename to docs/src/tutorials/_static/dspc.png diff --git a/docs/tutorials/_static/example.ort b/docs/src/tutorials/_static/example.ort similarity index 100% rename from docs/tutorials/_static/example.ort rename to docs/src/tutorials/_static/example.ort diff --git a/docs/tutorials/_static/monolayer.png b/docs/src/tutorials/_static/monolayer.png similarity index 100% rename from docs/tutorials/_static/monolayer.png rename to docs/src/tutorials/_static/monolayer.png diff --git a/docs/tutorials/_static/monolayer.svg b/docs/src/tutorials/_static/monolayer.svg similarity index 100% rename from docs/tutorials/_static/monolayer.svg rename to docs/src/tutorials/_static/monolayer.svg diff --git a/docs/tutorials/_static/multiple.ort b/docs/src/tutorials/_static/multiple.ort similarity index 100% rename from docs/tutorials/_static/multiple.ort rename to docs/src/tutorials/_static/multiple.ort diff --git a/docs/tutorials/_static/polymer_film.png b/docs/src/tutorials/_static/polymer_film.png similarity index 100% rename from docs/tutorials/_static/polymer_film.png rename to docs/src/tutorials/_static/polymer_film.png diff --git a/docs/tutorials/_static/polymer_film.svg b/docs/src/tutorials/_static/polymer_film.svg similarity index 100% rename from docs/tutorials/_static/polymer_film.svg rename to docs/src/tutorials/_static/polymer_film.svg diff --git a/docs/tutorials/_static/repeating.png b/docs/src/tutorials/_static/repeating.png similarity index 100% rename from docs/tutorials/_static/repeating.png rename to docs/src/tutorials/_static/repeating.png diff --git a/docs/tutorials/_static/repeating.svg b/docs/src/tutorials/_static/repeating.svg similarity index 100% rename from docs/tutorials/_static/repeating.svg rename to docs/src/tutorials/_static/repeating.svg diff --git a/docs/tutorials/_static/repeating_layers.ort b/docs/src/tutorials/_static/repeating_layers.ort similarity index 100% rename from docs/tutorials/_static/repeating_layers.ort rename to docs/src/tutorials/_static/repeating_layers.ort diff --git a/docs/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-0.0.ort b/docs/src/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-0.0.ort similarity index 100% rename from docs/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-0.0.ort rename to docs/src/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-0.0.ort diff --git a/docs/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-1.0.ort b/docs/src/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-1.0.ort similarity index 100% rename from docs/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-1.0.ort rename to docs/src/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-1.0.ort diff --git a/docs/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-10.0.ort b/docs/src/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-10.0.ort similarity index 100% rename from docs/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-10.0.ort rename to docs/src/tutorials/_static/resolution/mod_pointwise_two_layer_sample_dq-10.0.ort diff --git a/docs/tutorials/_static/two_layers.png b/docs/src/tutorials/_static/two_layers.png similarity index 100% rename from docs/tutorials/_static/two_layers.png rename to docs/src/tutorials/_static/two_layers.png diff --git a/docs/tutorials/_static/two_layers.svg b/docs/src/tutorials/_static/two_layers.svg similarity index 100% rename from docs/tutorials/_static/two_layers.svg rename to docs/src/tutorials/_static/two_layers.svg diff --git a/docs/tutorials/material_solvated.ipynb b/docs/src/tutorials/material_solvated.ipynb similarity index 98% rename from docs/tutorials/material_solvated.ipynb rename to docs/src/tutorials/material_solvated.ipynb index 92551c1f..5b9eeeea 100644 --- a/docs/tutorials/material_solvated.ipynb +++ b/docs/src/tutorials/material_solvated.ipynb @@ -43,7 +43,7 @@ "from EasyReflectometry.sample import MaterialSolvated\n", "from EasyReflectometry.sample import Multilayer\n", "from EasyReflectometry.experiment import Model\n", - "from EasyReflectometry.experiment import constant_resolution_function\n", + "from EasyReflectometry.experiment import percentage_fhwm_resolution_function\n", "from EasyReflectometry.calculators import CalculatorFactory\n", "from EasyReflectometry.fitting import Fitter\n", "from EasyReflectometry.plot import plot" @@ -182,7 +182,7 @@ "\n", "subphase = Layer(material=d2o, thickness=0, roughness=3, name='D2O Subphase')\n", "\n", - "resolution_function = constant_resolution_function(0.02)\n", + "resolution_function = percentage_fhwm_resolution_function(0.02)\n", "sample = Sample(superphase, solvated_film_layer, subphase, name='Film Structure')\n", "model = Model(\n", " sample=sample,\n", diff --git a/docs/tutorials/monolayer.ipynb b/docs/src/tutorials/monolayer.ipynb similarity index 99% rename from docs/tutorials/monolayer.ipynb rename to docs/src/tutorials/monolayer.ipynb index c93c43ad..f9da88ef 100644 --- a/docs/tutorials/monolayer.ipynb +++ b/docs/src/tutorials/monolayer.ipynb @@ -41,7 +41,7 @@ "from EasyReflectometry.sample import Layer\n", "from EasyReflectometry.sample import Sample\n", "from EasyReflectometry.experiment import Model\n", - "from EasyReflectometry.experiment import constant_resolution_function\n", + "from EasyReflectometry.experiment import percentage_fhwm_resolution_function\n", "from EasyReflectometry.fitting import Fitter\n", "from EasyReflectometry.plot import plot\n", "\n" @@ -317,7 +317,7 @@ "metadata": {}, "outputs": [], "source": [ - "resolution_function = constant_resolution_function(5)\n", + "resolution_function = percentage_fhwm_resolution_function(5)\n", "sample = Sample(air_layer, dspc, d2o_layer)\n", "model = Model(\n", " sample=sample,\n", diff --git a/docs/tutorials/multi_contrast.ipynb b/docs/src/tutorials/multi_contrast.ipynb similarity index 99% rename from docs/tutorials/multi_contrast.ipynb rename to docs/src/tutorials/multi_contrast.ipynb index dfb0d66e..801bd7e7 100644 --- a/docs/tutorials/multi_contrast.ipynb +++ b/docs/src/tutorials/multi_contrast.ipynb @@ -39,7 +39,7 @@ "from EasyReflectometry.sample import LayerAreaPerMolecule\n", "from EasyReflectometry.sample import Sample\n", "from EasyReflectometry.experiment import Model\n", - "from EasyReflectometry.experiment import constant_resolution_function\n", + "from EasyReflectometry.experiment import percentage_fhwm_resolution_function\n", "from EasyReflectometry.calculators import CalculatorFactory\n", "from EasyReflectometry.fitting import Fitter\n", "print(f'EasyReflectometry: {EasyReflectometry.__version__}')\n", @@ -405,7 +405,7 @@ "metadata": {}, "outputs": [], "source": [ - "resolution_function = constant_resolution_function(5)\n", + "resolution_function = percentage_fhwm_resolution_function(5)\n", "\n", "d13d2o_sample = Sample(air_layer, d13d2o, d2o_layer)\n", "d70d2o_sample = Sample(air_layer, d70d2o, d2o_layer)\n", diff --git a/docs/tutorials/repeating.ipynb b/docs/src/tutorials/repeating.ipynb similarity index 98% rename from docs/tutorials/repeating.ipynb rename to docs/src/tutorials/repeating.ipynb index 2c829e92..b16c61ea 100644 --- a/docs/tutorials/repeating.ipynb +++ b/docs/src/tutorials/repeating.ipynb @@ -43,7 +43,7 @@ "from EasyReflectometry.sample import Material\n", "from EasyReflectometry.sample import RepeatingMultilayer\n", "from EasyReflectometry.experiment import Model\n", - "from EasyReflectometry.experiment import constant_resolution_function\n", + "from EasyReflectometry.experiment import percentage_fhwm_resolution_function\n", "from EasyReflectometry.calculators import CalculatorFactory\n", "from EasyReflectometry.fitting import Fitter\n", "from EasyReflectometry.plot import plot" @@ -191,7 +191,7 @@ "metadata": {}, "outputs": [], "source": [ - "resolution_function = constant_resolution_function(0)\n", + "resolution_function = percentage_fhwm_resolution_function(0)\n", "sample = Sample(superphase, rep_multilayer, subphase, name='Multilayer Structure')\n", "model = Model(\n", " sample=sample,\n", diff --git a/docs/tutorials/resolution_functions.ipynb b/docs/src/tutorials/resolution_functions.ipynb similarity index 100% rename from docs/tutorials/resolution_functions.ipynb rename to docs/src/tutorials/resolution_functions.ipynb diff --git a/docs/tutorials/simple_fitting.ipynb b/docs/src/tutorials/simple_fitting.ipynb similarity index 99% rename from docs/tutorials/simple_fitting.ipynb rename to docs/src/tutorials/simple_fitting.ipynb index f034c24f..250a5915 100644 --- a/docs/tutorials/simple_fitting.ipynb +++ b/docs/src/tutorials/simple_fitting.ipynb @@ -37,7 +37,7 @@ "from EasyReflectometry.sample import Material\n", "from EasyReflectometry.sample import Multilayer\n", "from EasyReflectometry.experiment import Model\n", - "from EasyReflectometry.experiment import constant_resolution_function\n", + "from EasyReflectometry.experiment import percentage_fhwm_resolution_function\n", "from EasyReflectometry.calculators import CalculatorFactory\n", "from EasyReflectometry.fitting import Fitter\n", "from EasyReflectometry.plot import plot" @@ -297,7 +297,7 @@ "metadata": {}, "outputs": [], "source": [ - "resolution_function = constant_resolution_function(0.02)\n", + "resolution_function = percentage_fhwm_resolution_function(0.02)\n", "model = Model(\n", " sample=sample,\n", " scale=1,\n", diff --git a/docs/tutorials/tutorials.rst b/docs/src/tutorials/tutorials.rst similarity index 100% rename from docs/tutorials/tutorials.rst rename to docs/src/tutorials/tutorials.rst diff --git a/docs/usage.rst b/docs/src/usage.rst similarity index 100% rename from docs/usage.rst rename to docs/src/usage.rst