Skip to content

Fix image links in README for Python bindings and WebApp #464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
win-vid wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix image links in README for Python bindings and WebApp #464

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,8 @@ For additional information, please visit our [Wiki](https://hz-b.github.io/rayx/
## Built with RAYX

### RAYX Python Bindings
[![Repository](https://img.shields.io/badge/Repository-blue?logo=github)](https://github.com/hz-b/rayx-python)

@win-vid win-vid Apr 23, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

accidentally deleted [![Repository](https://img.shields.io/badge/Repository-blue?logo=github)](https://github.com/hz-b/rayx-python)

<img src="https://github.com/hz-b/rayx/blob/d1c05005dba41b49a87a4acd7e3e159fd11d51b9/docs/res/readme/python-bindings.png" alt="RAYX-Python Bindings">
![RAYX-Python Bindings](https://raw.githubusercontent.com/hz-b/rayx/master/docs/res/readme/python-bindings.png)

To simplify the integration of RAYX into Python-based workflows, we provide Python bindings that allow direct simulation results. The figure above illustrates the simulated output at each element of a beamline using the *RAYX Python Bindings* and *Matplotlib*.

Expand All @@ -45,14 +44,14 @@ To add RAYX to your Python project simply install the package by typing: ```pip

[![Repository](https://img.shields.io/badge/Repository-blue?logo=github)](https://github.com/hz-b/rayx-webapp)

<img src="https://github.com/hz-b/rayx/blob/d1c05005dba41b49a87a4acd7e3e159fd11d51b9/docs/res/readme/rayx-webapp.gif" alt="RAYX WebApp">
![RAYX - WebApp](https://raw.githubusercontent.com/hz-b/rayx/master/docs/res/readme/rayx-webapp.gif)

A lightweight Flask-based web application for visualizing <a href="https://github.com/hz-b/rayx">RAYX beamline simulations</a>.
The web app allows users to upload an `.rml` file, trace the beamline using the *RAYX Python bindings*, and interactively inspect the resulting ray distributions as 2D histograms with per-element breakdowns.

### RAYX-UI

<img src="https://github.com/hz-b/rayx/blob/d1c05005dba41b49a87a4acd7e3e159fd11d51b9/docs/res/readme/rayx-ui.jpg" alt="RAYX-UI Interface">
![Repository](https://raw.githubusercontent.com/hz-b/rayx/master/docs/res/readme/rayx-ui.jpg)

For users who prefer a more visual approach, _rayx-ui_ offers a graphical user interface (GUI) that includes a 3D viewport of the beamline, enabling interactive design and exploration. This GUI provides an intuitive interface to construct and modify beamlines, allowing users to visualize their designs in real-time. _rayx-ui_ not only enhances the design process but also allows users to iteratively optimize configurations based on immediate visual feedback.

Expand All @@ -73,4 +72,4 @@ This publication provides an overview of the software's architecture and capabil

* <a href="https://doi.org/10.1107/S1600577524003850">Automated spectrometer alignment via machine learning</a>

* <a href="http://doi.org/10.1088/1742-6596/3010/1/012131">Inverse Surrogate Model of a Soft X-Ray Spectrometer using Domain Adaptation</a>
* <a href="http://doi.org/10.1088/1742-6596/3010/1/012131">Inverse Surrogate Model of a Soft X-Ray Spectrometer using Domain Adaptation</a>
Loading