From c8346d542a5d7fddcd1085ffcc1f593fb05b5675 Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (o)" <j.wuttke@fz-juelich.de>
Date: Fri, 23 Jun 2023 15:16:18 +0200
Subject: [PATCH] rm 'Returns'
---
Examples/bayesian/likelihood_sampling.py | 2 +-
Examples/fit/scatter2d/consecutive_fitting.py | 4 ++--
Examples/fit/scatter2d/expfit_galaxi.py | 2 +-
Examples/fit/scatter2d/minimizer_settings.py | 4 ++--
Examples/fit/scatter2d/model2_hexlattice.py | 2 +-
Examples/fit/scatter2d/multiple_datasets.py | 4 ++--
Examples/fit/specular/FitSpecularBasics.py | 2 +-
Examples/fit/specular/RealLifeReflectometryFitting.py | 2 +-
Examples/scatter2d/ApproximationDA.py | 2 +-
Examples/scatter2d/ApproximationLMA.py | 2 +-
Examples/scatter2d/ApproximationSSCA.py | 2 +-
Examples/scatter2d/BiMaterialCylinders.py | 2 +-
Examples/scatter2d/CoreShellNanoparticles.py | 2 +-
Examples/scatter2d/CoreShellNanoparticles2.py | 2 +-
Examples/scatter2d/CorrelatedRoughness.py | 2 +-
Examples/scatter2d/CosineRipplesAtRectLattice.py | 2 +-
Examples/scatter2d/CustomFormFactor.py | 2 +-
Examples/scatter2d/CylindersAndPrisms.py | 2 +-
Examples/scatter2d/CylindersInAverageLayer.py | 2 +-
Examples/scatter2d/CylindersInBA.py | 2 +-
Examples/scatter2d/FindPeaks.py | 2 +-
Examples/scatter2d/GratingMC.py | 2 +-
Examples/scatter2d/HalfSpheresInAverageTopLayer.py | 2 +-
Examples/scatter2d/HexagonalLatticesWithBasis.py | 2 +-
Examples/scatter2d/Interference1DLattice.py | 2 +-
Examples/scatter2d/Interference1DRadialParacrystal.py | 2 +-
Examples/scatter2d/Interference2DCenteredSquareLattice.py | 2 +-
Examples/scatter2d/Interference2DParacrystal.py | 2 +-
Examples/scatter2d/Interference2DRotatedSquareLattice.py | 2 +-
Examples/scatter2d/Interference2DSquareFiniteLattice.py | 2 +-
Examples/scatter2d/LargeParticlesFormFactor.py | 2 +-
Examples/scatter2d/Mesocrystal.py | 2 +-
Examples/scatter2d/Mesocrystal2.py | 2 +-
Examples/scatter2d/PolarizedSANS.py | 4 ++--
Examples/scatter2d/RectangularGrating.py | 2 +-
Examples/scatter2d/RotatedPyramids.py | 2 +-
Examples/scatter2d/SpheresAtHexLattice.py | 2 +-
Examples/scatter2d/TriangularRipple.py | 2 +-
Examples/specular/BeamFullDivergence.py | 2 +-
Examples/specular/PolarizedSpinAsymmetry.py | 2 +-
Examples/specular/VsGenx.py | 2 +-
Examples/varia/AccessingSimulationResults.py | 2 +-
Examples/varia/OffspecSimulation.py | 4 ++--
Examples/varia/Resonator.py | 2 +-
44 files changed, 49 insertions(+), 49 deletions(-)
diff --git a/Examples/bayesian/likelihood_sampling.py b/Examples/bayesian/likelihood_sampling.py
index 9794f1fff89..8ef812a964f 100755
--- a/Examples/bayesian/likelihood_sampling.py
+++ b/Examples/bayesian/likelihood_sampling.py
@@ -58,7 +58,7 @@ def get_sample(ni_thickness, ti_thickness):
def get_real_data():
"""
Loading data from genx_interchanging_layers.dat
- Returns a Nx3 array (N - the number of experimental data entries)
+ A Nx3 array (N - the number of experimental data entries)
with first column being coordinates,
second one being values, and the third the uncertainties.
"""
diff --git a/Examples/fit/scatter2d/consecutive_fitting.py b/Examples/fit/scatter2d/consecutive_fitting.py
index 9503baba4f9..c8c891f19a4 100755
--- a/Examples/fit/scatter2d/consecutive_fitting.py
+++ b/Examples/fit/scatter2d/consecutive_fitting.py
@@ -15,7 +15,7 @@ from bornagain import ba_fitmonitor, deg, angstrom, nm
def get_sample(params):
"""
- Returns a sample with uncorrelated cylinders and pyramids on a substrate.
+ A sample with uncorrelated cylinders and pyramids on a substrate.
"""
radius = params["radius"]
height = params["height"]
@@ -42,7 +42,7 @@ def get_sample(params):
def get_simulation(params):
"""
- Returns a GISAXS simulation with beam and detector defined.
+ A GISAXS simulation with beam and detector defined.
"""
beam = ba.Beam(1e8, 1*angstrom, 0.2*deg)
n = 100 # bp.simargs['n']
diff --git a/Examples/fit/scatter2d/expfit_galaxi.py b/Examples/fit/scatter2d/expfit_galaxi.py
index ea940852c70..7ccf85be3e3 100755
--- a/Examples/fit/scatter2d/expfit_galaxi.py
+++ b/Examples/fit/scatter2d/expfit_galaxi.py
@@ -92,7 +92,7 @@ def get_sample(params):
def create_detector():
"""
- Returns a model of the GALAXY detector
+ A model of the GALAXY detector
"""
u0 = beam_xpos*pilatus_pixel_size # in mm
v0 = beam_ypos*pilatus_pixel_size # in mm
diff --git a/Examples/fit/scatter2d/minimizer_settings.py b/Examples/fit/scatter2d/minimizer_settings.py
index b13b01df6a2..90751cff621 100755
--- a/Examples/fit/scatter2d/minimizer_settings.py
+++ b/Examples/fit/scatter2d/minimizer_settings.py
@@ -8,7 +8,7 @@ from bornagain import deg, angstrom, nm
def get_sample(params):
"""
- Returns a sample with uncorrelated cylinders and prisms on a substrate.
+ A sample with uncorrelated cylinders and prisms on a substrate.
"""
cylinder_height = params["cylinder_height"]
cylinder_radius = params["cylinder_radius"]
@@ -43,7 +43,7 @@ def get_sample(params):
def get_simulation(params):
"""
- Returns a GISAXS simulation with beam and detector defined
+ A GISAXS simulation with beam and detector defined
"""
beam = ba.Beam(1e8, 1*angstrom, 0.2*deg)
n = 100 # bp.simargs['n']
diff --git a/Examples/fit/scatter2d/model2_hexlattice.py b/Examples/fit/scatter2d/model2_hexlattice.py
index a8b695d34dc..64e5c5e75f3 100644
--- a/Examples/fit/scatter2d/model2_hexlattice.py
+++ b/Examples/fit/scatter2d/model2_hexlattice.py
@@ -4,7 +4,7 @@ import numpy as np
def get_sample(params):
"""
- Returns a sample with cylinders and pyramids on a substrate,
+ A sample with cylinders and pyramids on a substrate,
forming a hexagonal lattice.
"""
radius = params['radius']
diff --git a/Examples/fit/scatter2d/multiple_datasets.py b/Examples/fit/scatter2d/multiple_datasets.py
index ddc48c6a15d..5c9673a23e6 100755
--- a/Examples/fit/scatter2d/multiple_datasets.py
+++ b/Examples/fit/scatter2d/multiple_datasets.py
@@ -11,7 +11,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample(params):
"""
- Returns a sample with uncorrelated cylinders and pyramids.
+ A sample with uncorrelated cylinders and pyramids.
"""
radius_a = params["radius_a"]
radius_b = params["radius_b"]
@@ -39,7 +39,7 @@ def get_sample(params):
def get_simulation(params):
"""
- Returns a GISAXS simulation with beam and detector defined.
+ A GISAXS simulation with beam and detector defined.
"""
incident_angle = params["incident_angle"]
diff --git a/Examples/fit/specular/FitSpecularBasics.py b/Examples/fit/specular/FitSpecularBasics.py
index d0864ad4dec..6bbb5330563 100755
--- a/Examples/fit/specular/FitSpecularBasics.py
+++ b/Examples/fit/specular/FitSpecularBasics.py
@@ -56,7 +56,7 @@ def get_sample(params):
def get_real_data(filename):
"""
Loading data from genx_interchanging_layers.dat
- Returns a Nx2 array (N - the number of experimental data entries)
+ A Nx2 array (N - the number of experimental data entries)
with first column being coordinates,
second one being values.
"""
diff --git a/Examples/fit/specular/RealLifeReflectometryFitting.py b/Examples/fit/specular/RealLifeReflectometryFitting.py
index bb3277c0bb4..59760b92b90 100755
--- a/Examples/fit/specular/RealLifeReflectometryFitting.py
+++ b/Examples/fit/specular/RealLifeReflectometryFitting.py
@@ -42,7 +42,7 @@ from bornagain import ba_plot
def get_real_data(filename):
"""
Loads real data files and merges them once.
- Returns a Nx3 array (N - the number of experimental data entries)
+ A Nx3 array (N - the number of experimental data entries)
with first column being coordinates,
second one being values,
and the third one being weights to restore intensity values from experiment
diff --git a/Examples/scatter2d/ApproximationDA.py b/Examples/scatter2d/ApproximationDA.py
index 6ffb2dbe842..914764732c2 100755
--- a/Examples/scatter2d/ApproximationDA.py
+++ b/Examples/scatter2d/ApproximationDA.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with cylinders of two different sizes on a substrate.
+ A sample with cylinders of two different sizes on a substrate.
The cylinder positions are modelled in Decoupling Approximation.
"""
diff --git a/Examples/scatter2d/ApproximationLMA.py b/Examples/scatter2d/ApproximationLMA.py
index 9f897d5736e..66bbdd05443 100755
--- a/Examples/scatter2d/ApproximationLMA.py
+++ b/Examples/scatter2d/ApproximationLMA.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with cylinders of two different sizes on a substrate.
+ A sample with cylinders of two different sizes on a substrate.
The cylinder positions are modelled in Local Monodisperse Approximation.
"""
diff --git a/Examples/scatter2d/ApproximationSSCA.py b/Examples/scatter2d/ApproximationSSCA.py
index 570d895e3d9..c7e2e4ec973 100755
--- a/Examples/scatter2d/ApproximationSSCA.py
+++ b/Examples/scatter2d/ApproximationSSCA.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with cylinders of two different sizes on a substrate.
+ A sample with cylinders of two different sizes on a substrate.
The cylinder positions are modelled in Size-Spacing Coupling Approximation.
"""
diff --git a/Examples/scatter2d/BiMaterialCylinders.py b/Examples/scatter2d/BiMaterialCylinders.py
index 95607f1fb41..d60af385c17 100755
--- a/Examples/scatter2d/BiMaterialCylinders.py
+++ b/Examples/scatter2d/BiMaterialCylinders.py
@@ -9,7 +9,7 @@ from bornagain import ba_plot as bp, deg, nm, R3
def get_sample():
"""
- Returns a multi layer with substrate/air layers.
+ A multi layer with substrate/air layers.
Vacuum layer contains cylindrical particles made of two materials.
Particle shifted down to cross interface.
"""
diff --git a/Examples/scatter2d/CoreShellNanoparticles.py b/Examples/scatter2d/CoreShellNanoparticles.py
index 6b066644647..83db874cc10 100755
--- a/Examples/scatter2d/CoreShellNanoparticles.py
+++ b/Examples/scatter2d/CoreShellNanoparticles.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm, std_samples
def get_sample():
"""
- Returns a sample with box-shaped core-shell particles.
+ A sample with box-shaped core-shell particles.
"""
# Materials
diff --git a/Examples/scatter2d/CoreShellNanoparticles2.py b/Examples/scatter2d/CoreShellNanoparticles2.py
index 02feb0d13ba..b94f645e0e0 100755
--- a/Examples/scatter2d/CoreShellNanoparticles2.py
+++ b/Examples/scatter2d/CoreShellNanoparticles2.py
@@ -9,7 +9,7 @@ from bornagain import ba_plot as bp, deg, nm, std_samples, R3
def get_sample():
"""
- Returns a sample with box-shaped core-shell particles.
+ A sample with box-shaped core-shell particles.
"""
# Materials
diff --git a/Examples/scatter2d/CorrelatedRoughness.py b/Examples/scatter2d/CorrelatedRoughness.py
index 0f2cce499a4..e2421960674 100755
--- a/Examples/scatter2d/CorrelatedRoughness.py
+++ b/Examples/scatter2d/CorrelatedRoughness.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with two layers on a substrate, with correlated roughnesses.
+ A sample with two layers on a substrate, with correlated roughnesses.
"""
# defining materials
m_vacuum = ba.RefractiveMaterial("ambience", 0, 0)
diff --git a/Examples/scatter2d/CosineRipplesAtRectLattice.py b/Examples/scatter2d/CosineRipplesAtRectLattice.py
index dea49215252..8717e8a0b5b 100755
--- a/Examples/scatter2d/CosineRipplesAtRectLattice.py
+++ b/Examples/scatter2d/CosineRipplesAtRectLattice.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with cosine ripples on a substrate.
+ A sample with cosine ripples on a substrate.
The structure is modelled as a 2D Lattice.
"""
diff --git a/Examples/scatter2d/CustomFormFactor.py b/Examples/scatter2d/CustomFormFactor.py
index 747612fb84e..0c3e8ead86a 100755
--- a/Examples/scatter2d/CustomFormFactor.py
+++ b/Examples/scatter2d/CustomFormFactor.py
@@ -50,7 +50,7 @@ class CustomFormFactor(ba.IFormFactor):
def get_sample():
"""
- Returns a sample with particles, having a custom form factor, on a substrate.
+ A sample with particles, having a custom form factor, on a substrate.
"""
# defining materials
m_vacuum = ba.RefractiveMaterial("Vacuum", 0, 0)
diff --git a/Examples/scatter2d/CylindersAndPrisms.py b/Examples/scatter2d/CylindersAndPrisms.py
index c420f50aac7..dbb7526572a 100755
--- a/Examples/scatter2d/CylindersAndPrisms.py
+++ b/Examples/scatter2d/CylindersAndPrisms.py
@@ -7,7 +7,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with uncorrelated cylinders and prisms on a substrate.
+ A sample with uncorrelated cylinders and prisms on a substrate.
"""
# Materials
diff --git a/Examples/scatter2d/CylindersInAverageLayer.py b/Examples/scatter2d/CylindersInAverageLayer.py
index e0ccf47ef56..ba8b72953b3 100755
--- a/Examples/scatter2d/CylindersInAverageLayer.py
+++ b/Examples/scatter2d/CylindersInAverageLayer.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm, R3
def get_sample(cyl_height=5*nm):
"""
- Returns a sample with cylinders on a substrate.
+ A sample with cylinders on a substrate.
"""
# defining materials
m_vacuum = ba.RefractiveMaterial("Vacuum", 0, 0)
diff --git a/Examples/scatter2d/CylindersInBA.py b/Examples/scatter2d/CylindersInBA.py
index efacc1c0934..821252724d8 100755
--- a/Examples/scatter2d/CylindersInBA.py
+++ b/Examples/scatter2d/CylindersInBA.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with cylinders in a homogeneous environment ("Vacuum"),
+ A sample with cylinders in a homogeneous environment ("Vacuum"),
implying a simulation in plain Born approximation.
"""
diff --git a/Examples/scatter2d/FindPeaks.py b/Examples/scatter2d/FindPeaks.py
index 459e8fe37cb..56d6cd62dc4 100755
--- a/Examples/scatter2d/FindPeaks.py
+++ b/Examples/scatter2d/FindPeaks.py
@@ -11,7 +11,7 @@ from matplotlib import pyplot as plt
def get_sample(lattice_rotation_angle=0*deg):
"""
- Returns a sample with a grating on a substrate.
+ A sample with a grating on a substrate.
lattice_rotation_angle = 0 - beam parallel to grating lines
lattice_rotation_angle = 90*deg - beam perpendicular to grating lines
"""
diff --git a/Examples/scatter2d/GratingMC.py b/Examples/scatter2d/GratingMC.py
index e9b3aa25b38..b0f9c1924ca 100755
--- a/Examples/scatter2d/GratingMC.py
+++ b/Examples/scatter2d/GratingMC.py
@@ -12,7 +12,7 @@ from matplotlib import pyplot as plt
def get_sample(lattice_rotation_angle=0*deg):
"""
- Returns a sample with a grating on a substrate.
+ A sample with a grating on a substrate.
lattice_rotation_angle = 0 - beam parallel to grating lines
lattice_rotation_angle = 90*deg - beam perpendicular to grating lines
"""
diff --git a/Examples/scatter2d/HalfSpheresInAverageTopLayer.py b/Examples/scatter2d/HalfSpheresInAverageTopLayer.py
index 52f32d914fe..90ee41d9f97 100755
--- a/Examples/scatter2d/HalfSpheresInAverageTopLayer.py
+++ b/Examples/scatter2d/HalfSpheresInAverageTopLayer.py
@@ -9,7 +9,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with cylinders on a substrate.
+ A sample with cylinders on a substrate.
"""
# Materials
diff --git a/Examples/scatter2d/HexagonalLatticesWithBasis.py b/Examples/scatter2d/HexagonalLatticesWithBasis.py
index f3530ed5ee5..05a1b6e17fd 100755
--- a/Examples/scatter2d/HexagonalLatticesWithBasis.py
+++ b/Examples/scatter2d/HexagonalLatticesWithBasis.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm, R3
def get_sample():
"""
- Returns a sample with spheres on a substrate,
+ A sample with spheres on a substrate,
forming two hexagonal close packed layers.
"""
diff --git a/Examples/scatter2d/Interference1DLattice.py b/Examples/scatter2d/Interference1DLattice.py
index ec71d28f61c..e01b4189849 100755
--- a/Examples/scatter2d/Interference1DLattice.py
+++ b/Examples/scatter2d/Interference1DLattice.py
@@ -10,7 +10,7 @@ from bornagain import angstrom, ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with a grating on a substrate,
+ A sample with a grating on a substrate,
modelled by very long boxes forming a 1D lattice with Cauchy correlations.
"""
diff --git a/Examples/scatter2d/Interference1DRadialParacrystal.py b/Examples/scatter2d/Interference1DRadialParacrystal.py
index 78bdcca10cf..49d78973797 100755
--- a/Examples/scatter2d/Interference1DRadialParacrystal.py
+++ b/Examples/scatter2d/Interference1DRadialParacrystal.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with cylinders on a substrate that form a radial paracrystal.
+ A sample with cylinders on a substrate that form a radial paracrystal.
"""
# Materials
diff --git a/Examples/scatter2d/Interference2DCenteredSquareLattice.py b/Examples/scatter2d/Interference2DCenteredSquareLattice.py
index 85ef78ca457..f7750f56d92 100755
--- a/Examples/scatter2d/Interference2DCenteredSquareLattice.py
+++ b/Examples/scatter2d/Interference2DCenteredSquareLattice.py
@@ -11,7 +11,7 @@ a = 25*nm # lattice constant
def get_sample():
"""
- Returns a sample with cylinders on a substrate,
+ A sample with cylinders on a substrate,
forming a 2D centered square lattice
"""
diff --git a/Examples/scatter2d/Interference2DParacrystal.py b/Examples/scatter2d/Interference2DParacrystal.py
index fb4df529491..6897ca937af 100755
--- a/Examples/scatter2d/Interference2DParacrystal.py
+++ b/Examples/scatter2d/Interference2DParacrystal.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with cylinders on a substrate, forming a 2D paracrystal
+ A sample with cylinders on a substrate, forming a 2D paracrystal
"""
# Materials
diff --git a/Examples/scatter2d/Interference2DRotatedSquareLattice.py b/Examples/scatter2d/Interference2DRotatedSquareLattice.py
index c001a20b3d6..83b0dc99fe3 100755
--- a/Examples/scatter2d/Interference2DRotatedSquareLattice.py
+++ b/Examples/scatter2d/Interference2DRotatedSquareLattice.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with cylinders on a substrate, forming a rotated 2D lattice
+ A sample with cylinders on a substrate, forming a rotated 2D lattice
"""
# Materials
diff --git a/Examples/scatter2d/Interference2DSquareFiniteLattice.py b/Examples/scatter2d/Interference2DSquareFiniteLattice.py
index 11b8af26443..672029e36fd 100755
--- a/Examples/scatter2d/Interference2DSquareFiniteLattice.py
+++ b/Examples/scatter2d/Interference2DSquareFiniteLattice.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm, nm2
def get_sample():
"""
- Returns a sample with cylinders on a substrate, forming a 2D square lattice.
+ A sample with cylinders on a substrate, forming a 2D square lattice.
"""
# Materials
diff --git a/Examples/scatter2d/LargeParticlesFormFactor.py b/Examples/scatter2d/LargeParticlesFormFactor.py
index b8e5888713d..639dfaeec40 100755
--- a/Examples/scatter2d/LargeParticlesFormFactor.py
+++ b/Examples/scatter2d/LargeParticlesFormFactor.py
@@ -41,7 +41,7 @@ def get_sample(cylinder_radius, cylinder_height):
def get_simulation(sample, integration_flag):
"""
- Returns a GISAXS simulation with defined beam and detector.
+ A GISAXS simulation with defined beam and detector.
If integration_flag=True, the simulation will integrate over detector bins.
"""
beam = ba.Beam(1e9, 1*angstrom, 0.2*deg)
diff --git a/Examples/scatter2d/Mesocrystal.py b/Examples/scatter2d/Mesocrystal.py
index 196549e7b86..1a477858334 100755
--- a/Examples/scatter2d/Mesocrystal.py
+++ b/Examples/scatter2d/Mesocrystal.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm, R3
def get_sample():
"""
- Returns a sample with a cylindrically shaped mesocrystal on a substrate.
+ A sample with a cylindrically shaped mesocrystal on a substrate.
"""
# Materials
diff --git a/Examples/scatter2d/Mesocrystal2.py b/Examples/scatter2d/Mesocrystal2.py
index 614dd14e6de..c73bf7124f7 100755
--- a/Examples/scatter2d/Mesocrystal2.py
+++ b/Examples/scatter2d/Mesocrystal2.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm, R3
def get_sample():
"""
- Returns a sample with a cylindrically shaped mesocrystal on a substrate.
+ A sample with a cylindrically shaped mesocrystal on a substrate.
"""
# Materials
diff --git a/Examples/scatter2d/PolarizedSANS.py b/Examples/scatter2d/PolarizedSANS.py
index db9ff32f21a..84624c1f11f 100755
--- a/Examples/scatter2d/PolarizedSANS.py
+++ b/Examples/scatter2d/PolarizedSANS.py
@@ -9,7 +9,7 @@ from bornagain import ba_plot as bp, deg, nm, R3
def get_sample():
"""
- Returns a sample with a magnetic core-shell particle in a solvent.
+ A sample with a magnetic core-shell particle in a solvent.
"""
# Materials
@@ -49,7 +49,7 @@ def get_sample():
def get_simulation(sample):
"""
- Returns a polarized SANS simulation
+ A polarized SANS simulation
"""
n = <%= sm ? 11 : 200 %>
diff --git a/Examples/scatter2d/RectangularGrating.py b/Examples/scatter2d/RectangularGrating.py
index 8bad201b488..b5e6dac2daf 100755
--- a/Examples/scatter2d/RectangularGrating.py
+++ b/Examples/scatter2d/RectangularGrating.py
@@ -10,7 +10,7 @@ from bornagain import ba_plot as bp, deg, micrometer, nm
def get_sample(lattice_rotation_angle=0*deg):
"""
- Returns a sample with a grating on a substrate.
+ A sample with a grating on a substrate.
lattice_rotation_angle = 0 - beam parallel to grating lines
lattice_rotation_angle = 90*deg - beam perpendicular to grating lines
"""
diff --git a/Examples/scatter2d/RotatedPyramids.py b/Examples/scatter2d/RotatedPyramids.py
index e7f82a5b8c7..bd022a3ded5 100755
--- a/Examples/scatter2d/RotatedPyramids.py
+++ b/Examples/scatter2d/RotatedPyramids.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with rotated pyramids on top of a substrate.
+ A sample with rotated pyramids on top of a substrate.
"""
# Materials
diff --git a/Examples/scatter2d/SpheresAtHexLattice.py b/Examples/scatter2d/SpheresAtHexLattice.py
index 240bf4dfc62..2b1e3c7c9e9 100755
--- a/Examples/scatter2d/SpheresAtHexLattice.py
+++ b/Examples/scatter2d/SpheresAtHexLattice.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with spherical particles on a substrate,
+ A sample with spherical particles on a substrate,
forming a hexagonal 2D lattice.
"""
diff --git a/Examples/scatter2d/TriangularRipple.py b/Examples/scatter2d/TriangularRipple.py
index 1107e8b96cc..19117b793a3 100755
--- a/Examples/scatter2d/TriangularRipple.py
+++ b/Examples/scatter2d/TriangularRipple.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with a grating on a substrate, modelled by triangular ripples
+ A sample with a grating on a substrate, modelled by triangular ripples
forming a 1D Paracrystal.
"""
diff --git a/Examples/specular/BeamFullDivergence.py b/Examples/specular/BeamFullDivergence.py
index 9806df281d1..4b583c4a72d 100755
--- a/Examples/specular/BeamFullDivergence.py
+++ b/Examples/specular/BeamFullDivergence.py
@@ -20,7 +20,7 @@ def get_sample():
def get_simulation(sample):
"""
- Returns a specular simulation with beam and detector defined.
+ A specular simulation with beam and detector defined.
"""
n = <%= sm ? 50 : 500 %>
diff --git a/Examples/specular/PolarizedSpinAsymmetry.py b/Examples/specular/PolarizedSpinAsymmetry.py
index 2d302597f97..945b203cba3 100755
--- a/Examples/specular/PolarizedSpinAsymmetry.py
+++ b/Examples/specular/PolarizedSpinAsymmetry.py
@@ -64,7 +64,7 @@ def get_sample(P):
def get_simulation(sample, q_axis, parameters, polarizer_dir,
analyzer_dir):
"""
- Returns a simulation object.
+ A simulation object.
Polarization, analyzer and resolution are set
from given parameters
"""
diff --git a/Examples/specular/VsGenx.py b/Examples/specular/VsGenx.py
index 102f9d7dcfe..1f08857aa5a 100755
--- a/Examples/specular/VsGenx.py
+++ b/Examples/specular/VsGenx.py
@@ -33,7 +33,7 @@ def get_sample():
def get_simulation(sample, **kwargs):
"""
- Returns a specular simulation with beam and detector defined.
+ A specular simulation with beam and detector defined.
"""
n = <%= sm ? 50 : 500 %>
footprint = ba.FootprintSquare(beam_sample_ratio)
diff --git a/Examples/varia/AccessingSimulationResults.py b/Examples/varia/AccessingSimulationResults.py
index 5371b4e7039..ffd18ad30b1 100755
--- a/Examples/varia/AccessingSimulationResults.py
+++ b/Examples/varia/AccessingSimulationResults.py
@@ -15,7 +15,7 @@ def get_sample():
def get_simulation(sample):
"""
- Returns a GISAXS simulation with beam and detector defined.
+ A GISAXS simulation with beam and detector defined.
"""
beam = ba.Beam(1e5, 1*angstrom, 0.2*deg)
n = <%= sm ? 50 : 200 %>
diff --git a/Examples/varia/OffspecSimulation.py b/Examples/varia/OffspecSimulation.py
index 0e564358bb5..90ee50b024c 100755
--- a/Examples/varia/OffspecSimulation.py
+++ b/Examples/varia/OffspecSimulation.py
@@ -8,7 +8,7 @@ from bornagain import ba_plot as bp, deg, nm
def get_sample():
"""
- Returns a sample with a grating on a substrate,
+ A sample with a grating on a substrate,
modelled by infinitely long boxes forming a 1D lattice.
"""
@@ -51,7 +51,7 @@ def get_sample():
def get_simulation(sample):
"""
- Returns an off-specular simulation with beam and detector defined.
+ An off-specular simulation with beam and detector defined.
"""
n = <%= sm ? 50 : 200 %>
scan = ba.AlphaScan(n, 0.1*deg, 10*deg)
diff --git a/Examples/varia/Resonator.py b/Examples/varia/Resonator.py
index c3cf80aff76..a2d9b03ee30 100755
--- a/Examples/varia/Resonator.py
+++ b/Examples/varia/Resonator.py
@@ -63,7 +63,7 @@ def get_sample():
def get_simulation(sample):
"""
- Returns a depth-probe simulation.
+ A depth-probe simulation.
"""
nz = <%= sm ? 20 : 500 %>
na = <%= sm ? 40 : 5000 %>
--
GitLab