diff --git a/hugo/content/ex/sim/depthprobe/transmitted_modulus.md b/hugo/content/ex/sim/depthprobe/transmitted_modulus.md index 74412e009764d3e051e7cba83fc4956b2513309d..d9ee5ec35995f58ef3a395c48da2c7677dbf8aaa 100644 --- a/hugo/content/ex/sim/depthprobe/transmitted_modulus.md +++ b/hugo/content/ex/sim/depthprobe/transmitted_modulus.md @@ -9,7 +9,7 @@ Modulus of the amplitude of the partial wave field propagating in transmission direction, as function of depth and incident angle $\alpha_i$. -Same sample as in the previous [basic example](depthprobe1), +Same sample as in the basic example [depthprobe1](/ex/sim/depthprobe/depthprobe1), a thin film on a substrate. diff --git a/hugo/content/ex/sim/gisas/_index.md b/hugo/content/ex/sim/gisas/_index.md index bdb04eb3cf7ab71ff9b4ab31c9d07bd2f5a6d648..4229b0ad49ce06f59778cbe62d422e34ba6128e6 100644 --- a/hugo/content/ex/sim/gisas/_index.md +++ b/hugo/content/ex/sim/gisas/_index.md @@ -22,7 +22,7 @@ a dilute random assembly of monodisperse cylindrical disks on a substrate. #### Function get_simulation -The simulation of type [ScatteringSimulation](/py/sim/class/scattering) +The simulation of type [ScatteringSimulation](/ref/sim/class/scattering) is defined by beam, sample, and detector. The incoming beam is defined by the constructor `Beam` with arguments intensity, @@ -47,7 +47,7 @@ default pixel size (which is retrieved by `bp.simargs['n']` in function `get_simulation`. The function call `simulation.simulate()` runs the simulation and returns -a [Datafield](/ref/result/datafield) object. +a [Datafield](/ref/sim/simulation-result) object. ### Further reading diff --git a/hugo/content/ex/sim/specular.md b/hugo/content/ex/sim/specular.md index 477d2e4045e98a0d95dac185f687373ac1348911..aabb1fb6d42e2a43c065f2f780caf2accd06c172 100644 --- a/hugo/content/ex/sim/specular.md +++ b/hugo/content/ex/sim/specular.md @@ -10,8 +10,8 @@ by a sample that consists of 10 Ti/Ni double layers on a Si substrate. ##### Full script -The same script has been used in the tutorial to explain [usage](/py/start/run.md) -and [syntax](/py/start/syntax.md) of BornAgain Python code. +The same script has been used in the tutorial to explain [usage](/py/run.md) +and [syntax](/py/syntax.md) of BornAgain Python code. Root class reference: [SpecularSimulation](/ref/sim/class/specular). diff --git a/hugo/content/installation/building/unix/third-party.md b/hugo/content/installation/building/unix/third-party.md index b733a2fbc4c9e586c73049d4d898cfc71fa018be..929392266e41c2840edc6242df65f614e7ea3228 100644 --- a/hugo/content/installation/building/unix/third-party.md +++ b/hugo/content/installation/building/unix/third-party.md @@ -38,7 +38,7 @@ Recommended software: * For generating a man page: * `perl` -* For [Matplotlib usetex mode](/ex/result/matplotlib.md): +* For [Matplotlib usetex mode](/ref/result/matplotlib): * `texlive-latex-extra` (and dependencies) * `dvipng` * `cm-super-minimal` diff --git a/hugo/content/py/run.md b/hugo/content/py/run.md index 715d7fe409c1825fa54d9815e7c1c3bf10f79e9b..0cc93868c7d27300b49b3b6a8b607e2cb3eca9df 100644 --- a/hugo/content/py/run.md +++ b/hugo/content/py/run.md @@ -9,12 +9,12 @@ To get started with BornAgain scripting, run a first example. We assume that BornAgain and Python are [installed]({{% relref "installation" %}}) -and that you verified that the Python interpreter can -[find](/py/start/find.md) the module `bornagain`. +and that the Python interpreter can `import bornagain` +(see [preceding page](/py), "Check Installation"). We shall now run a first example script. This and all other example scripts can also be found in the BornAgain distribution, -in directory `Examples`. +in directory {{% ref-src "auto/Examples" %}}. Download the following example script, using the link just below the code frame. @@ -25,7 +25,7 @@ Save the script under the name `AlternatingLayers1.py`. <p> For a discussion of the content of this script, -see [simulation/reflectometry](/ref/sim/class/specular/_index.md). +see [simulation/reflectometry](/ref/sim/class/specular). ### From the command line diff --git a/hugo/content/ref/sample/particle/ff/hard/bipyramid4.md b/hugo/content/ref/sample/particle/ff/hard/bipyramid4.md index 8ea9875d65b4c5955aff38a39828b42718e1576b..c541c6bd6b6e0759870206b9cb0a78934407dd4d 100644 --- a/hugo/content/ref/sample/particle/ff/hard/bipyramid4.md +++ b/hugo/content/ref/sample/particle/ff/hard/bipyramid4.md @@ -29,7 +29,7 @@ $H \le \dfrac{\tan\alpha}{2} L \quad $ and $ \quad r_{H} H \le \dfrac{\tan\alpha #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -46,9 +46,9 @@ $$V=\dfrac{L^3\tan\alpha}{6}\Big[2-\Big(1-\dfrac{2H}{L\tan\alpha}\Big)^3-\Big(1- #### Related shapes More special: -- [Pyramid4](/py/sample/particle/ff/hard/pyramid4), if $r_H \to \infty$. -- [Box](/py/sample/particle/ff/hard/box), if $\alpha=90^{\circ}$. -- [PlatonicOctahedron](/py/sample/particle/ff/hard/platonicoctahedron), if regular and not truncated. +- [Pyramid4](/ref/sample/particle/ff/hard/pyramid4), if $r_H \to \infty$. +- [Box](/ref/sample/particle/ff/hard/box), if $\alpha=90^{\circ}$. +- [PlatonicOctahedron](/ref/sample/particle/ff/hard/platonicoctahedron), if regular and not truncated. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/box.md b/hugo/content/ref/sample/particle/ff/hard/box.md index fa1c35eaea06d31240ad8fa3de81f8601f7127ee..98a0d74b19b48de4c5b6f17d592795e5fd242179 100644 --- a/hugo/content/ref/sample/particle/ff/hard/box.md +++ b/hugo/content/ref/sample/particle/ff/hard/box.md @@ -23,7 +23,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -40,15 +40,15 @@ $$V=LWH.$$ #### Related shapes More general: -- [Pyramid2](/py/sample/particle/ff/hard/pyramid2) or [Pyramid4](/py/sample/particle/ff/hard/pyramid4), if sides are not vertical. +- [Pyramid2](/ref/sample/particle/ff/hard/pyramid2) or [Pyramid4](/ref/sample/particle/ff/hard/pyramid4), if sides are not vertical. More special: -<!--- [Bar](/py/sample/particle/ff/hard/bar), if elongated in L or W direction.--> +<!--- [Bar](/ref/sample/particle/ff/hard/bar), if elongated in L or W direction.--> - Bar, if elongated in L or W direction. Modified cubes: -- [TruncatedCube](/py/sample/particle/ff/hard/truncatedcube), if $L=W=H$ and corners are facetted. -- [CantellatedCube](/py/sample/particle/ff/hard/cantellatedcube), if $L=W=H$ and corners and edges are facetted. +- [TruncatedCube](/ref/sample/particle/ff/hard/truncatedcube), if $L=W=H$ and corners are facetted. +- [CantellatedCube](/ref/sample/particle/ff/hard/cantellatedcube), if $L=W=H$ and corners and edges are facetted. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/cantellatedcube.md b/hugo/content/ref/sample/particle/ff/hard/cantellatedcube.md index a2bee2a19848a050dbaed6c8c57b409eac800b4f..6fce74105b5ef746037a155a2191ed9bf86cc188 100644 --- a/hugo/content/ref/sample/particle/ff/hard/cantellatedcube.md +++ b/hugo/content/ref/sample/particle/ff/hard/cantellatedcube.md @@ -28,7 +28,7 @@ $ t \le L/2 $ #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -43,8 +43,8 @@ $$ V= L^3 - 6Lt^2 + \dfrac{16}{3} t^3. $$ #### Related shapes -- [Box](/py/sample/particle/ff/hard/box), a rectangular cuboid. -- [TruncatedCube](/py/sample/particle/ff/hard/truncatedcube), if truncated vertices only. +- [Box](/ref/sample/particle/ff/hard/box), a rectangular cuboid. +- [TruncatedCube](/ref/sample/particle/ff/hard/truncatedcube), if truncated vertices only. Scattering by uncorrelated, oriented cantellated cubes for horizontal incidence. Rotation around $z$ axis: diff --git a/hugo/content/ref/sample/particle/ff/hard/cone.md b/hugo/content/ref/sample/particle/ff/hard/cone.md index 5b1885f78f1dede58af3bfd89baefba07ff5ac93..97b435a5be196f3710379e931e3b1e91f038cb34 100644 --- a/hugo/content/ref/sample/particle/ff/hard/cone.md +++ b/hugo/content/ref/sample/particle/ff/hard/cone.md @@ -27,7 +27,7 @@ $H \le R \tan\alpha$ #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -50,7 +50,7 @@ $$V=\dfrac{\pi}{3}\tan\alpha \left( R^3 - R_H^3\right).$$ #### Related shapes More special: -- [Cylinder](/py/sample/particle/ff/hard/cylinder), if $\alpha=90^{\circ}$. +- [Cylinder](/ref/sample/particle/ff/hard/cylinder), if $\alpha=90^{\circ}$. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/cylinder.md b/hugo/content/ref/sample/particle/ff/hard/cylinder.md index cf1f124d43cd66c1fbd77c56e4cbf9c46ca5bc12..eb30b29f73d800a65762f9e591e3bbc8d2e7d36c 100644 --- a/hugo/content/ref/sample/particle/ff/hard/cylinder.md +++ b/hugo/content/ref/sample/particle/ff/hard/cylinder.md @@ -22,7 +22,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -43,9 +43,9 @@ $$V=\pi R^2H.$$ #### Related shapes More general: -- [Cone](/py/sample/particle/ff/hard/cone), if radius varies with z. -- [EllipsoidalCylinder](/py/sample/particle/ff/hard/ellipsoidalcylinder), if base is an ellipse. -- [HorizontalCylinder](/py/sample/particle/ff/hard/horizontalcylinder), if horizontal and truncated. +- [Cone](/ref/sample/particle/ff/hard/cone), if radius varies with z. +- [EllipsoidalCylinder](/ref/sample/particle/ff/hard/ellipsoidalcylinder), if base is an ellipse. +- [HorizontalCylinder](/ref/sample/particle/ff/hard/horizontalcylinder), if horizontal and truncated. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/dodecahedron.md b/hugo/content/ref/sample/particle/ff/hard/dodecahedron.md index a44ffbdce80c93484121c4925873766d1afabb71..e94459396aef95e0d4c402929e860c711b01aa4b 100644 --- a/hugo/content/ref/sample/particle/ff/hard/dodecahedron.md +++ b/hugo/content/ref/sample/particle/ff/hard/dodecahedron.md @@ -24,7 +24,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -39,7 +39,7 @@ $$ V= \dfrac{1}{4}(15+7\sqrt{5})a^3 \approx 7.663 \space a^3. $$ #### Related shapes -- [Icosahedron](/py/sample/particle/ff/hard/icosahedron), a regular icosahedron. +- [Icosahedron](/ref/sample/particle/ff/hard/icosahedron), a regular icosahedron. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/ellipsoidalcylinder.md b/hugo/content/ref/sample/particle/ff/hard/ellipsoidalcylinder.md index 7179358b2fe3b7709a79cd3d1f5ad1c958ee31ec..e68ba3073dc5b485050404296e50e92406be0bde 100644 --- a/hugo/content/ref/sample/particle/ff/hard/ellipsoidalcylinder.md +++ b/hugo/content/ref/sample/particle/ff/hard/ellipsoidalcylinder.md @@ -23,7 +23,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -44,7 +44,7 @@ $$V=\pi R_aR_bH.$$ #### Related shapes More special: -- [Cylinder](/py/sample/particle/ff/hard/cylinder), if base is circular. +- [Cylinder](/ref/sample/particle/ff/hard/cylinder), if base is circular. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/hemiellipsoid.md b/hugo/content/ref/sample/particle/ff/hard/hemiellipsoid.md index 408ffcfa1d757b95926918d5d1d9d72a598a4453..2edde517070a69d5ff6f4408c211f0d2b69899d2 100644 --- a/hugo/content/ref/sample/particle/ff/hard/hemiellipsoid.md +++ b/hugo/content/ref/sample/particle/ff/hard/hemiellipsoid.md @@ -23,7 +23,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -46,8 +46,8 @@ $$ V=\dfrac{2\pi}{3} R_aR_bH. $$ #### Related shapes -- [TruncatedSphere](/py/sample/particle/ff/hard/truncatedsphere), sphere truncated from the top and/or the bottom. -- [TruncatedSpheroid](/py/sample/particle/ff/hard/truncatedspheroid), spheroid truncated from the top and/or the bottom. +- [TruncatedSphere](/ref/sample/particle/ff/hard/truncatedsphere), sphere truncated from the top and/or the bottom. +- [TruncatedSpheroid](/ref/sample/particle/ff/hard/truncatedspheroid), spheroid truncated from the top and/or the bottom. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/horizontalcylinder.md b/hugo/content/ref/sample/particle/ff/hard/horizontalcylinder.md index 3b2def1a7b8cf8444c1b3a1b33163ba5d5cd406a..84dc10f8501d2ee38c5f7fd3cb97ca4cbfa22c04 100644 --- a/hugo/content/ref/sample/particle/ff/hard/horizontalcylinder.md +++ b/hugo/content/ref/sample/particle/ff/hard/horizontalcylinder.md @@ -33,7 +33,7 @@ $ -R \le b \le t \le R $ #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -53,7 +53,7 @@ $$V=L \Big\( t\sqrt{R^2-t^2}- b\sqrt{R^2-b^2} + R^2 \Big\[\text{asin}\Big(\frac{ #### Related shapes More general: -- [Cylinder](/py/sample/particle/ff/hard/cylinder), if vertical and non-truncated. +- [Cylinder](/ref/sample/particle/ff/hard/cylinder), if vertical and non-truncated. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/icosahedron.md b/hugo/content/ref/sample/particle/ff/hard/icosahedron.md index cfe08eee76c6b38bec0cd530c4d6addff769b121..8b41794df9b10f1ec1c3009c01ef5d10fa13c2d2 100644 --- a/hugo/content/ref/sample/particle/ff/hard/icosahedron.md +++ b/hugo/content/ref/sample/particle/ff/hard/icosahedron.md @@ -24,7 +24,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -39,7 +39,7 @@ $$ V= \dfrac{5}{12}(3+\sqrt{5})a^3 \approx 2.182 \space a^3. $$ #### Related shapes -- [Dodecahedron](/py/sample/particle/ff/hard/dodecahedron), a regular dodecahedron. +- [Dodecahedron](/ref/sample/particle/ff/hard/dodecahedron), a regular dodecahedron. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/platonicoctahedron.md b/hugo/content/ref/sample/particle/ff/hard/platonicoctahedron.md index 37d2f8e4453011eac3fa32b573f48e233f11dc3c..65f643415dbef564d1ed731e09703d41f4021f4f 100644 --- a/hugo/content/ref/sample/particle/ff/hard/platonicoctahedron.md +++ b/hugo/content/ref/sample/particle/ff/hard/platonicoctahedron.md @@ -24,7 +24,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -40,7 +40,7 @@ $$ V= \dfrac{\sqrt{2}}{3}L^3. $$ #### Related shapes More general: -- [Bipyramid4](/py/sample/particle/ff/hard/bipyramid4), if not regular and/or truncated. +- [Bipyramid4](/ref/sample/particle/ff/hard/bipyramid4), if not regular and/or truncated. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/platonictetrahedron.md b/hugo/content/ref/sample/particle/ff/hard/platonictetrahedron.md index 79366e9a9eb130fd113a91d87715e592d1d8f9c1..7740a0cb3626e1b354e8d62af8bab2f3758df95a 100644 --- a/hugo/content/ref/sample/particle/ff/hard/platonictetrahedron.md +++ b/hugo/content/ref/sample/particle/ff/hard/platonictetrahedron.md @@ -25,7 +25,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -41,7 +41,7 @@ $$ V= \dfrac{\sqrt{2}}{12}L^3. $$ #### Related shapes More general: -- [Pyramid3](/py/sample/particle/ff/hard/pyramid3), if not regular and/or truncated. +- [Pyramid3](/ref/sample/particle/ff/hard/pyramid3), if not regular and/or truncated. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/prism3.md b/hugo/content/ref/sample/particle/ff/hard/prism3.md index 8baa1254f1b87af2a7731107318b5d3866ce8140..2fb5a9a53f0b89744cddcd45fb13aef73fd6ceed 100644 --- a/hugo/content/ref/sample/particle/ff/hard/prism3.md +++ b/hugo/content/ref/sample/particle/ff/hard/prism3.md @@ -22,7 +22,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -42,7 +42,7 @@ $$ V=\dfrac{\sqrt3}{4}HL^2. $$ #### Related shapes More general: -- [Pyramid3](/py/sample/particle/ff/hard/pyramid3), if sides are not vertical. +- [Pyramid3](/ref/sample/particle/ff/hard/pyramid3), if sides are not vertical. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/prism6.md b/hugo/content/ref/sample/particle/ff/hard/prism6.md index 33b3d90f19931a0c8ac2ba7b7ac673085dc0d272..1f7aeb7af7271dd33de738c010fdd3c5c93d3f88 100644 --- a/hugo/content/ref/sample/particle/ff/hard/prism6.md +++ b/hugo/content/ref/sample/particle/ff/hard/prism6.md @@ -22,7 +22,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -42,7 +42,7 @@ $$ V=\dfrac{3\sqrt3}{2}HR^2. $$ #### Related shapes More general: -- [Pyramid6](/py/sample/particle/ff/hard/pyramid6), if sides are not vertical. +- [Pyramid6](/ref/sample/particle/ff/hard/pyramid6), if sides are not vertical. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/pyramid2.md b/hugo/content/ref/sample/particle/ff/hard/pyramid2.md index a5197f6c3d57ca7d69c498210a26371c4984b9c2..388ce26321504be73dd759035c8feae0d8cf6f12 100644 --- a/hugo/content/ref/sample/particle/ff/hard/pyramid2.md +++ b/hugo/content/ref/sample/particle/ff/hard/pyramid2.md @@ -28,7 +28,7 @@ $H \le \dfrac{\tan\alpha}{2} min(L,W)$ #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -45,8 +45,8 @@ $$ V=H\Big[LW-\dfrac{(L+W)H}{\tan\alpha}+\dfrac{4}{3}\dfrac{H^2}{\tan^2\alpha}\B #### Related shapes More special: -- [Pyramid4](/py/sample/particle/ff/hard/pyramid4), if $L=W$. -- [Box](/py/sample/particle/ff/hard/box), if $\alpha=90^{\circ}$. +- [Pyramid4](/ref/sample/particle/ff/hard/pyramid4), if $L=W$. +- [Box](/ref/sample/particle/ff/hard/box), if $\alpha=90^{\circ}$. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/pyramid3.md b/hugo/content/ref/sample/particle/ff/hard/pyramid3.md index 37a7d32cd2c1c01beb7c86e847d982259ea95c80..7f08b838abda8a62bcdc0c5d460a8c4edd677c22 100644 --- a/hugo/content/ref/sample/particle/ff/hard/pyramid3.md +++ b/hugo/content/ref/sample/particle/ff/hard/pyramid3.md @@ -30,7 +30,7 @@ It is related to the dihedral angle through $\tan\alpha = 2\tan\beta$. #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -47,8 +47,8 @@ $$ V=\dfrac{L^3\tan\alpha}{24}\Big[1-\Big(1-\dfrac{2\sqrt3H}{L\tan\alpha}\Big)^3 #### Related shapes More special: -- [Prism3](/py/sample/particle/ff/hard/prism3), if $\alpha=90^{\circ}$. -- [PlatonicTetrahedron](/py/sample/particle/ff/hard/platonitetrahedron), if regular and not truncated. +- [Prism3](/ref/sample/particle/ff/hard/prism3), if $\alpha=90^{\circ}$. +- [PlatonicTetrahedron](/ref/sample/particle/ff/hard/platonitetrahedron), if regular and not truncated. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/pyramid4.md b/hugo/content/ref/sample/particle/ff/hard/pyramid4.md index 0d1a17d6a46929c965b02595ea5e9e921232deea..b1162eed96acb3b43c2819f010f262b909dba5b6 100644 --- a/hugo/content/ref/sample/particle/ff/hard/pyramid4.md +++ b/hugo/content/ref/sample/particle/ff/hard/pyramid4.md @@ -27,7 +27,7 @@ $H \le \dfrac{\tan\alpha}{2} L$ #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -45,7 +45,7 @@ $$ V=\dfrac{L^3\tan\alpha}{6}\Big[1-\Big(1-\dfrac{2H}{L\tan\alpha}\Big)^3\Big]. #### Related shapes More general: -- [Pyramid2](/py/sample/particle/ff/hard/pyramid2), if base is rectangular. +- [Pyramid2](/ref/sample/particle/ff/hard/pyramid2), if base is rectangular. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/pyramid6.md b/hugo/content/ref/sample/particle/ff/hard/pyramid6.md index b2738276e41e7cffef076e3a813aed7579fbf738..e973473430eda2b8ab05007d2ad2ad45c1c144a7 100644 --- a/hugo/content/ref/sample/particle/ff/hard/pyramid6.md +++ b/hugo/content/ref/sample/particle/ff/hard/pyramid6.md @@ -29,7 +29,7 @@ Note that the orthographic projection does not show $\alpha$ but the angle $\bet #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -46,7 +46,7 @@ $$ V=\dfrac{3}{4}R^3\tan\alpha\Big[1-\Big(1-\dfrac{2H}{\sqrt3R\tan\alpha}\Big)^3 #### Related shapes More special: -- [Prism6](/py/sample/particle/ff/hard/prism6), if $\alpha=90^{\circ}$. +- [Prism6](/ref/sample/particle/ff/hard/prism6), if $\alpha=90^{\circ}$. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/sphere.md b/hugo/content/ref/sample/particle/ff/hard/sphere.md index efc97762783228bad8a4e28fc9c126db66740c65..b8f1e00919691519d2e15129339bd10584005c59 100644 --- a/hugo/content/ref/sample/particle/ff/hard/sphere.md +++ b/hugo/content/ref/sample/particle/ff/hard/sphere.md @@ -21,7 +21,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -43,8 +43,8 @@ $$ V=\dfrac{4\pi}{3} R^3. $$ #### Related shapes More general: -- [Spheroid](/py/sample/particle/ff/hard/fullspheroid), if ellipse in vertical cross section. -- [TruncatedSphere](/py/sample/particle/ff/hard/truncatedsphere), if truncated from the top and/or the bottom. +- [Spheroid](/ref/sample/particle/ff/hard/fullspheroid), if ellipse in vertical cross section. +- [TruncatedSphere](/ref/sample/particle/ff/hard/truncatedsphere), if truncated from the top and/or the bottom. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/spheroid.md b/hugo/content/ref/sample/particle/ff/hard/spheroid.md index 864bd91e85436ba40a23b7714d026c6f134d81a4..fdf09f9196c175c8dbd7707d16e185401ca13263 100644 --- a/hugo/content/ref/sample/particle/ff/hard/spheroid.md +++ b/hugo/content/ref/sample/particle/ff/hard/spheroid.md @@ -22,7 +22,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -42,10 +42,10 @@ $$ V=\dfrac{2\pi}{3} R^2H. $$ #### Related shapes More special: -- [Sphere](/py/sample/particle/ff/hard/fullsphere), if $H=2R.$ +- [Sphere](/ref/sample/particle/ff/hard/fullsphere), if $H=2R.$ More general: -- [TruncatedSpheroid](/py/sample/particle/ff/hard/truncatedspheroid), if truncated from the top and/or the bottom. +- [TruncatedSpheroid](/ref/sample/particle/ff/hard/truncatedspheroid), if truncated from the top and/or the bottom. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/truncatedcube.md b/hugo/content/ref/sample/particle/ff/hard/truncatedcube.md index 3fedcaf7f309e6230564feb2f3a57f417068488a..089f686624e4a81bf01b0c2a5957602f7424fcca 100644 --- a/hugo/content/ref/sample/particle/ff/hard/truncatedcube.md +++ b/hugo/content/ref/sample/particle/ff/hard/truncatedcube.md @@ -27,7 +27,7 @@ $ t \le L/2 $ #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -43,8 +43,8 @@ $$ V= L^3 - \dfrac{4}{3} t^3. $$ #### Related shapes -- [Box](/py/sample/particle/ff/hard/box), a rectangular cuboid. -- [CantellatedCube](/py/sample/particle/ff/hard/cantellatedcube), if truncated edges and vertices. +- [Box](/ref/sample/particle/ff/hard/box), a rectangular cuboid. +- [CantellatedCube](/ref/sample/particle/ff/hard/cantellatedcube), if truncated edges and vertices. #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/truncatedsphere.md b/hugo/content/ref/sample/particle/ff/hard/truncatedsphere.md index a09e693da6780f4ff626bc05e7b5a09b69a66c21..f31a61acd1b504e00ca525b86d355715f27f25d4 100644 --- a/hugo/content/ref/sample/particle/ff/hard/truncatedsphere.md +++ b/hugo/content/ref/sample/particle/ff/hard/truncatedsphere.md @@ -27,7 +27,7 @@ $ dh < H \le 2R $ #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -48,13 +48,13 @@ $$ V=\dfrac{\pi}{3} \[ 3R(H^2-dh^2) + dh^3 -H^3 \]. $$ #### Related shapes -- [HemiEllipsoid](/py/sample/particle/ff/hard/hemiellipsoid), top half of ellipsoid. +- [HemiEllipsoid](/ref/sample/particle/ff/hard/hemiellipsoid), top half of ellipsoid. More general: -- [TruncatedSpheroid](/py/sample/particle/ff/hard/truncatedspheroid), spheroid truncated from the top and/or the bottom. +- [TruncatedSpheroid](/ref/sample/particle/ff/hard/truncatedspheroid), spheroid truncated from the top and/or the bottom. More special: -- [Sphere](/py/sample/particle/ff/hard/sphere), if $H=2R, \space dh=0.$ +- [Sphere](/ref/sample/particle/ff/hard/sphere), if $H=2R, \space dh=0.$ #### Example diff --git a/hugo/content/ref/sample/particle/ff/hard/truncatedspheroid.md b/hugo/content/ref/sample/particle/ff/hard/truncatedspheroid.md index 71a3b8200f614cb1881ce7635067998593ca15a7..0b3d26d3fbda929b3e4e7dd6369689c4a5908af7 100644 --- a/hugo/content/ref/sample/particle/ff/hard/truncatedspheroid.md +++ b/hugo/content/ref/sample/particle/ff/hard/truncatedspheroid.md @@ -28,7 +28,7 @@ $ dh < H \le 2f_pR $ #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation @@ -49,11 +49,11 @@ $$ V=\dfrac{\pi}{3f_p^2} \[ 3f_pR(H^2-dh^2) + dh^3 -H^3 \]. $$ #### Related shapes -- [HemiEllipsoid](/py/sample/particle/ff/hard/hemiellipsoid), top half of ellipsoid. +- [HemiEllipsoid](/ref/sample/particle/ff/hard/hemiellipsoid), top half of ellipsoid. More special: -- [Spheroid](/py/sample/particle/ff/hard/spheroid), if $H=2f_pR, \space dh=0.$ -- [TruncatedSphere](/py/sample/particle/ff/hard/truncatedsphere), if $f_p=1$. +- [Spheroid](/ref/sample/particle/ff/hard/spheroid), if $H=2f_pR, \space dh=0.$ +- [TruncatedSphere](/ref/sample/particle/ff/hard/truncatedsphere), if $f_p=1$. #### Example diff --git a/hugo/content/ref/sample/particle/ff/ripples/index.md b/hugo/content/ref/sample/particle/ff/ripples/index.md index 7aef41c2728a18ae195be150d771a9339435e7b3..21ca64218f3bd6741bc15ee3adf6dcec745ea6bf 100644 --- a/hugo/content/ref/sample/particle/ff/ripples/index.md +++ b/hugo/content/ref/sample/particle/ff/ripples/index.md @@ -45,7 +45,7 @@ $ |d| \le W/2 $ #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation diff --git a/hugo/content/ref/sample/particle/ff/soft/fuzzysphere.md b/hugo/content/ref/sample/particle/ff/soft/fuzzysphere.md index 9ef8c2e93d534c6db438c9e57eb374c4c0ea72cd..a41956264cb792f89d6fec910dd115d40546ec1d 100644 --- a/hugo/content/ref/sample/particle/ff/soft/fuzzysphere.md +++ b/hugo/content/ref/sample/particle/ff/soft/fuzzysphere.md @@ -18,7 +18,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation diff --git a/hugo/content/ref/sample/particle/ff/soft/gauss.md b/hugo/content/ref/sample/particle/ff/soft/gauss.md index 29d93ef0b556434362095a8c76fb843e7bc9169c..49b2a70dbc877f0fcbf41eb1c9d9d7ba601530dc 100644 --- a/hugo/content/ref/sample/particle/ff/soft/gauss.md +++ b/hugo/content/ref/sample/particle/ff/soft/gauss.md @@ -18,7 +18,7 @@ Parameters: #### Usage -As for any other [Form factor](/py/sample/particle/ff). +As for any other [Form factor](/ref/sample/particle/ff). #### Implementation diff --git a/hugo/content/ref/sim/_index.md b/hugo/content/ref/sim/_index.md index bcfea9ff5c6b94a19c371dd768bcd8326363d613..a1c99f4bd95f2d6a3bd39d7a0fa417543c8e45f6 100644 --- a/hugo/content/ref/sim/_index.md +++ b/hugo/content/ref/sim/_index.md @@ -30,4 +30,4 @@ Setters: Getter: * `simulate()` - runs simulation and returns - [Datafield](/ref/result/datafield) + [Datafield](/ref/sim/simulation-result) diff --git a/hugo/content/ref/sim/class/depthprobe/index.md b/hugo/content/ref/sim/class/depthprobe/index.md index 235ebe64c27524c307a51dadc4040a952582024b..3f5301d8ca536a2665d29f4646aecbfd8e1038a3 100644 --- a/hugo/content/ref/sim/class/depthprobe/index.md +++ b/hugo/content/ref/sim/class/depthprobe/index.md @@ -29,7 +29,7 @@ For the constructor arguments, see sections [scan](/ref/instr/scan), For optional settings, see [simulation options](/ref/sim/setup/options). For the return type of function `simulate()`, -see [Datafield](/ref/result/datafield). +see [Datafield](/ref/sim/simulation-result). #### Partial waves, modulus, phase diff --git a/hugo/content/ref/sim/class/offspec/index.md b/hugo/content/ref/sim/class/offspec/index.md index b6e727b84916e62566f9be4012e3e82f6e95236c..8333b14739a7dee53c8b676900b2c974b12aa090 100644 --- a/hugo/content/ref/sim/class/offspec/index.md +++ b/hugo/content/ref/sim/class/offspec/index.md @@ -22,7 +22,7 @@ For the constructor arguments, see sections [scan](/ref/instr/scan), For optional settings, see [simulation options](/ref/sim/setup/options). For the return type of function `simulate()`, -see [Datafield](/ref/result/datafield). +see [Datafield](/ref/sim/simulation-result). ##### Examples diff --git a/hugo/content/ref/sim/class/scattering/index.md b/hugo/content/ref/sim/class/scattering/index.md index cb950a98b6ec1e48108d41e4aee67d851bf27196..fbe8131f1507acac2d8f07d8841e8a6fb321c5bd 100644 --- a/hugo/content/ref/sim/class/scattering/index.md +++ b/hugo/content/ref/sim/class/scattering/index.md @@ -22,7 +22,7 @@ For the constructor arguments, see sections [beam](/ref/instr/beam), For optional settings, see [simulation options](/ref/sim/setup/options). For the return type of function `simulate()`, -see [Datafield](/ref/result/datafield). +see [Datafield](/ref/sim/simulation-result). ##### SAS vs GISAS diff --git a/hugo/content/ref/sim/class/specular/index.md b/hugo/content/ref/sim/class/specular/index.md index f9e42847aef293b67b4929b49e6d863a7c0add64..8daa1aa228355ab827d4b7ffd36a42df645bb95b 100644 --- a/hugo/content/ref/sim/class/specular/index.md +++ b/hugo/content/ref/sim/class/specular/index.md @@ -21,7 +21,7 @@ and [sample](/ref/sample). For optional settings, see [simulation options](/ref/sim/setup/options). For the return type of function `simulate()`, -see [Datafield](/ref/result/datafield). +see [Datafield](/ref/sim/simulation-result). ##### Examples