diff --git a/Examples/bayesian/likelihood_sampling.py b/Examples/bayesian/likelihood_sampling.py index 9794f1fff89c00f35250fa8d7d1961fc29eaf69d..8ef812a964f13f807435475d0b8b7836b4759f1d 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 9503baba4f9d49b2fef029d8bc91959fb24b91d5..c8c891f19a4f45855f98eb692f6f341672096742 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 ea940852c70ed4376601b73c889c7bccfcb6a7ce..7ccf85be3e3c42dbb32dc6f6f37518a3a7211e1f 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 b13b01df6a2220ca95a1d7292759a942c189bc6b..90751cff621cb4357f79ad8497b3142718aff887 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 a8b695d34dc22dc561165965a335516df665bab3..64e5c5e75f312b3e0e0b0c81ab9faae3ed69196f 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 ddc48c6a15d287c0393f4ebccc6130d8b893240e..5c9673a23e6bfc72e676ec1bf13513f93dd574bb 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 d0864ad4dec8270fe3dbd8ec058f02c3894d7a0b..6bbb533056346943587a82adf8326f65ef954460 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 bb3277c0bb46b76f039285f3c3a21bbe407fa68a..59760b92b9014f0518b7d6a10c703a8b60753f5a 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 6ffb2dbe84274329138df8ed7ef6718b5f2358cb..914764732c21298ae9aad380483d989d3c977b17 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 9f897d5736e60a8ff3e17698b990795b165f9b87..66bbdd05443422ae13a5a0a9321c4ded01f0246f 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 570d895e3d9816c9c8c912c0b5a0687870d681c2..c7e2e4ec973ddc821244ffb7c4fadf706900b303 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 95607f1fb4136d23ee549261ac2b216984100aa8..d60af385c179100814c4eea9005e0aa691e422c9 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 6b066644647e0729d2b438dff6ae12f86da1e5db..83db874cc102fa4066864f3fc16ad5ce4c6abf2a 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 02feb0d13ba944eb35096f0e22b786ed67d344f0..b94f645e0e0d6f2e4a7aedfc892a9c0906cff39b 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 0f2cce499a4721c4a5118adadf86f160a92045c0..e24219606740d96478d0bfe943b6e850fe07059e 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 dea49215252d122e3fac46e833df7acf2824b43e..8717e8a0b5b3a13fe6a06ccccde8a166e29862c9 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 747612fb84e535b3bafb93a1ea79a4334fe0a314..0c3e8ead86a8f756a775a829e6fbb89af9fe67ac 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 c420f50aac7e157343811ce6de3b8d48033b4bad..dbb7526572a6ee3691a98d713d9eef5b737d6664 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 e0ccf47ef565edbcd2c6d707504af2b2c99e9a59..ba8b72953b3479d49a9d6ba8ba989ed2d17dff1a 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 efacc1c093450feb111aef5f47d1e65f9dce7b13..821252724d885ab7d6113d5b18f8a313f7327f81 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 459e8fe37cb7a225416d9f861af780c9eaccc1a6..56d6cd62dc4bb374c9a5a9a1791baa6611002826 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 e9b3aa25b385f4e1ed1f9f2af287398b2fe40df7..b0f9c1924ca8c870c3a4472b62138d3b49574789 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 52f32d914fe88c725e3ccc77eea38d6a7b0c913a..90ee41d9f9790594352595ca052e5817d6d428e0 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 f3530ed5ee58bb4cb05774f46985cfbc45247676..05a1b6e17fd1b6f6b2ceed192286f406f30250f5 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 ec71d28f61ca7708f79c881e75d9ba348151d1c7..e01b4189849208ae8d835b84ae57c8b5835c3e9a 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 78bdcca10cff7a8ab0f4ac974617b68286597146..49d7897379778befc90ed58c98e4b3143bbb9711 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 85ef78ca457104db8df758f325c1e668a28ea609..f7750f56d929f73e82b575fd1f0aafaaf7fec0d7 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 fb4df52949108cf5950294b8b3ecefcbe974152a..6897ca937af805bccbbfd93c9f7b9bf947acb7ad 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 c001a20b3d6005333bba8eb9bd3214509e4f5823..83b0dc99fe36f29529b5334d7050add2a5c4f05d 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 11b8af264435be11b520f89dfd5126a50177b959..672029e36fdc5f0dbf267d84b3b6861b652ea244 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 b8e5888713d479f329425f929a3dc9a2a7740b87..639dfaeec4050022d42f6eb48baddf1ddc432e1a 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 196549e7b86dcc3183cdf25b5c013107c9003aca..1a477858334afa4689eac7728f5b5159151dc98a 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 614dd14e6de443116df5c695ad1f8dab61eac7e6..c73bf7124f7fdb72f65da4f8a6b7063c0a964f48 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 db9ff32f21a0fef4b728a7d4c624d40a14ad9894..84624c1f11f6c5217647586a3f26fe4e5acdc5cd 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 8bad201b48895b101e0683edbc1c5402e894a4de..b5e6dac2daf63f8a457a30b36ef2f709341f6fbd 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 e7f82a5b8c7966826ae7525f558e4c5a20715bbf..bd022a3ded5286e745b79d6d8ed7ad744e5e5a23 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 240bf4dfc62a6925c1093aa2b8922cbd914d1fc7..2b1e3c7c9e98ef0bf1b9be8da6f62e487fb8efa5 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 1107e8b96cc8fe8dcf1dbcfd0311a43cc42a13f0..19117b793a3d1d04667c821aa9761c707ccb9acd 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 9806df281d1b9b8abea7306ef3423014e37589b3..4b583c4a72d17908609da976a9cc685abf22c556 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 2d302597f9716dd28ffe27007e2a72c22671e445..945b203cba38929e69db10b23ad20241dd9a7f6d 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 102f9d7dcfe555957f3f248eaba26fe53cec2ffe..1f08857aa5a225b639cebf6bbb9ec7820a814c9c 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 5371b4e703989d49d501d39d86d65ba8e8407cc5..ffd18ad30b16de712f9eee3d69254dbcdef56db2 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 0e564358bb5acd2d37ae452c3040bd00b06c5549..90ee50b024c432ff5d9e3b4bdc4df8a3469a10ae 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 c3cf80aff7647bac00588e132c37d5f830c695fb..a2d9b03ee30a76347a71dccdeab7fca93d4b336d 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 %>