Documentation #2381

Examples present on the website and missing on the BA repo

Added by juan 8 months ago. Updated 8 months ago.

Status:ResolvedStart date:29 Jul 2019
Priority:ImmediateDue date:
Assignee:juan% Done:

0%

Category:-
Target version:Sprint 41

Description

There is an example tutorial on FootprintCorrection in the BornAgan website (https://www.bornagainproject.org/documentation/tutorial-examples/reflectometry/footprint-correction/) with a snippet included.
The same example is missing on the BornAgain repository. I have pasted below the output of the directory containing the python examples, where it can be seen that there is none corresponding to Footprint Correction.

Examples/python/
├── fitting
│   ├── ex01_BasicExamples
│   │   ├── basic_fitting_tutorial_data.txt.gz
│   │   ├── basic_fitting_tutorial.py
│   │   ├── consecutive_fitting.py
│   │   ├── minimal_fit_example.py
│   │   └── minimizer_settings.py
│   ├── ex02_AdvancedExamples
│   │   ├── find_background.py
│   │   ├── fit_along_slices.py
│   │   ├── fit_with_masks.py
│   │   └── multiple_datasets.py
│   ├── ex03_ExtendedExamples
│   │   ├── custom_objective_function
│   │   │   └── custom_objective_function.py
│   │   ├── experiment_at_galaxi
│   │   │   ├── fit_galaxi_data.py
│   │   │   ├── galaxi_data.tif.gz
│   │   │   └── sample_builder.py
│   │   ├── external_minimizer
│   │   │   ├── lmfit_basics.py
│   │   │   └── lmfit_with_plotting.py
│   │   └── specular
│   │   ├── FitSpecularBasics.py
│   │   ├── FitWithUncertainties.py
│   │   ├── genx_interchanging_layers.dat.gz
│   │   ├── mg6a_Merged.txt.gz
│   │   └── RealLifeReflectometryFitting.py
│   └── README.md
├── README
├── simulation
│   ├── ex01_BasicParticles
│   │   ├── AllFormFactorsAvailable.py
│   │   ├── CylindersAndPrisms.py
│   │   ├── CylindersInBA.py
│   │   ├── CylindersInDWBA.py
│   │   ├── CylindersWithSizeDistribution.py
│   │   ├── RotatedPyramids.py
│   │   └── TwoTypesOfCylindersWithSizeDistribution.py
│   ├── ex02_LayeredStructures
│   │   ├── BuriedParticles.py
│   │   └── CorrelatedRoughness.py
│   ├── ex03_InterferenceFunctions
│   │   ├── ApproximationDA.py
│   │   ├── ApproximationLMA.py
│   │   ├── ApproximationSSCA.py
│   │   ├── CosineRipplesAtRectLattice.py
│   │   ├── Interference1DLattice.py
│   │   ├── Interference1DRadialParaCrystal.py
│   │   ├── Interference2DCenteredSquareLattice.py
│   │   ├── Interference2DLatticeSumOfRotated.py
│   │   ├── Interference2DParaCrystal.py
│   │   ├── Interference2DRotatedSquareLattice.py
│   │   ├── Interference2DSquareFiniteLattice.py
│   │   ├── Interference2DSquareLattice.py
│   │   ├── RectangularGrating.py
│   │   ├── SpheresAtHexLattice.py
│   │   └── TriangularRipple.py
│   ├── ex04_ComplexShapes
│   │   ├── BiMaterialCylinders.py
│   │   ├── CoreShellNanoparticles.py
│   │   ├── CustomFormFactor.py
│   │   ├── HexagonalLatticesWithBasis.py
│   │   ├── LargeParticlesFormFactor.py
│   │   ├── MesoCrystal.py
│   │   └── ParticlesCrossingInterface.py
│   ├── ex05_BeamAndDetector
│   │   ├── BeamDivergence.py
│   │   ├── ConstantBackground.py
│   │   ├── DetectorResolutionFunction.py
│   │   ├── OffSpecularSimulation.py
│   │   ├── RectangularDetector.py
│   │   └── ResonatorOffSpecSetup.py
│   ├── ex06_Reflectometry
│   │   ├── BasicSpecularSimulation.py
│   │   ├── BeamAngularDivergence_copy.py
│   │   ├── BeamAngularDivergence.py
│   │   ├── BeamFullDivergence_copy.py
│   │   ├── BeamFullDivergence.py
│   │   ├── genx_angular_divergence.dat.gz
│   │   ├── MaterialProfile.py
│   │   ├── MaterialProfileWithParticles.py
│   │   ├── TimeOfFlightReflectometry.py
│   │   └── TOFRWithResolution.py
│   └── ex07_Miscellaneous
│   ├── AccessingSimulationResults.py
│   ├── AxesInDifferentUnits.py
│   ├── BoxesWithSpecularPeak.py
│   ├── CylindersInAverageLayer.py
│   ├── DepthProbe.py
│   ├── FindPeaks.py
│   ├── HalfSpheresInAverageTopLayer.py
│   ├── MagneticSpheres.py
│   ├── PolarizedSANS.py
│   └── SimulationParameters.py
└── utils
├── init.py
├── plot_intensity_data_diff.py
├── plot_intensity_data.py
├── show2d.py
└── show2d_root.py

History

#1 Updated by juan 8 months ago

  • Tracker changed from Bug to Documentation

#2 Updated by juan 8 months ago

The same holds true for the tutorial "Specular Simulation With a Rough Sample" https://www.bornagainproject.org/documentation/tutorial-examples/reflectometry/specular-simulation-with-roughness/

#3 Updated by juan 8 months ago

  • Subject changed from Footprint Correction example missing to Examples present on the website and missing on the BA repo

#4 Updated by dmitry 8 months ago

  • Status changed from New to Resolved

Also available in: Atom PDF