Skip to content

Commit fd289b9

Browse files
committed
Documentation updates
1 parent 67d4d84 commit fd289b9

File tree

3 files changed

+10
-24
lines changed

3 files changed

+10
-24
lines changed

docs/changes/lastChanges.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Changes
22

3-
- Introduce SemVer
4-
- Introduced new Testsuite, improvements include
5-
- performance
6-
- readability
7-
- some bug fixes
8-
- Bugfix wiki math display
9-
- Bugfix Metrix Beamline Tracing
10-
- Bugfix Toroid & Ellipsoid
11-
- Bugfix multi rzp script
12-
- Minor code reworks
3+
- Addition of first prototype for RAYX-UI, which allows rendering of beamlines
4+
- Added -s option for sequential tracing
5+
- Added option for specific h5 format when exporting rays
6+
- Bug fixes for the RZP (but still being worked on)
7+
- Added additional benchmarking tools
8+
- Exposed additional RAYX-CORE features for outside use
9+
- Improved documentation
10+
- Improved software testing

docs/changes/v0.15.7.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/src/Model/OpticalElements/OpticalElements.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Optical elements in RAYX are conceptualized as shown below:
99
![image](../../res/ray-coord.png)
1010
_Source: [Schaefers](https://gitlab.helmholtz-berlin.de/RAY/RAY/-/wikis/uploads/bdcf4515e03b2fccf462c5f0d76052c3/Paper_Schaefers_RAY_Springer_2007.pdf)_
1111

12-
The rule to keep in mind here is that if rays pass through an optical element, the element is placed in the XY-Plane; otherwise, it is in the XZ-Plane. The reasoning behind this is that the default direction of rays is always along the z-axis. This simplifies the design of beamlines, which mostly proceed in a straight line.
12+
The rule to keep in mind here is that if rays pass through an optical element, the element is placed in the XY-Plane; otherwise, it is in the XZ-Plane. The reasoning behind this is that the default direction of rays is always along the z-axis. This simplifies the design of beamlines, which mostly proceed in a straight line. This is subject to change, as we are currently discussing, having all elements in the XZ-Plane.
1313

1414
To orient the optical element within the entire beamline, we can simply adjust the direction matrix. Defining the basis vectors of the direction matrix provides full control over the orientation of the optical elements/surfaces.
1515

@@ -38,7 +38,7 @@ The cutout itself does not have a position; it is always at the origin of the el
3838

3939
### Behavior
4040

41-
Behavior determines whether an optical element is a slit, grating, RZP (special grating), mirror, or other. This classification aids the tracing process by specifying how rays will interact with the object. Ray interactions with elements are categorized as events. Here are some types of events (for more, see the Doxygen documentation):
41+
Behavior determines whether an optical element is a slit, grating, [RZP](./RZP.md), mirror, or other. This classification aids the tracing process by specifying how rays will interact with the object. Ray interactions with elements are categorized as events. Here are some types of events (for more, see the Doxygen documentation):
4242

4343
- Fly off: The ray did not intersect with an element and will not be traced further.
4444
- Just hit: The ray did intersect with an element and will continue to be traced.

0 commit comments

Comments
 (0)