Skip to content

Commit 05ddc9a

Browse files
Merge branch 'michabirklbauer:master' into master
2 parents d6cf88e + 7e630f7 commit 05ddc9a

8 files changed

Lines changed: 37 additions & 5 deletions

File tree

app/layout.jsx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,17 @@ export const metadata = {
77
// Define your metadata here
88
// For more information on metadata API, see: https://nextjs.org/docs/app/building-your-application/optimizing/metadata
99
title: 'pyXLMS',
10-
description: 'User guide and documentation for pyXLMS'
10+
description: 'User guide and documentation for pyXLMS',
11+
authors: [{ name: 'Micha' }, { name: 'Birklbauer', url: 'https://github.com/michabirklbauer' }],
12+
creator: 'Micha Birklbauer',
13+
publisher: 'Micha Birklbauer'
1114
}
1215

1316
const navbar = (
1417
<Navbar
1518
logo={
1619
<>
17-
<img src="https://github.com/hgb-bin-proteomics/pyXLMS/raw/master/docs/logo/logo.png" width="48" style={{padding: '0px 10px 0px 0px'}}/>
20+
<img src="/logo.png" width="48" height="48" style={{padding: '0px 10px 0px 0px'}}/>
1821
<h1>pyXLMS</h1>
1922
</>
2023
}
@@ -46,6 +49,7 @@ export default async function RootLayout({ children }) {
4649
docsRepositoryBase="https://github.com/michabirklbauer/pyXLMS-docs/tree/master"
4750
footer={footer}
4851
// ... Your additional layout options
52+
sidebar={{ defaultMenuCollapseLevel: 1 }}
4953
>
5054
{children}
5155
</Layout>

content/docs/index.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,26 @@
11
# Introduction
22

3+
<br/>
4+
<div style={{ textAlign: 'justify' }}>
5+
36
**pyXLMS** is a python package and web application with graphical user interface that aims to simplify and streamline the intermediate step of
47
connecting crosslink search engine results with down-stream analysis tools, enabling researchers even without bioinformatics knowledge to
58
conduct in-depth crosslink analyses and shifting the focus from data transformation to data interpretation and therefore gaining biological
69
insight.
710

11+
</div>
12+
13+
![Workflow of pyXLMS"](/workflow.png)
14+
15+
<div style={{ textAlign: 'left' }}>
16+
17+
_**Figure 1:** Overview of available functionality in pyXLMS as of version 1.4.3 [August 2025]._
18+
19+
</div>
20+
21+
<br/>
22+
<div style={{ textAlign: 'justify' }}>
23+
824
Currently pyXLMS supports input from seven different crosslink search engines:
925
[MaxLynx (part of MaxQuant)](https://www.maxquant.org/),
1026
[MeroX](https://www.stavrox.com/),
@@ -26,3 +42,5 @@ Down-stream analysis is facilitated by functionality that is directly available
2642
pyMOL (via [pyXlinkViewer](https://github.com/BobSchiffrin/PyXlinkViewer)),
2743
ChimeraX (via [XMAS](https://github.com/ScheltemaLab/ChimeraX_XMAS_bundle)),
2844
or [IMP-X-FDR](https://github.com/vbc-proteomics-org/imp-x-fdr).
45+
46+
</div>

content/docs/plotting/plot_peptide_pair_distribution.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ from pyXLMS import __version__
99
print(f"Installed pyXLMS version: {__version__}")
1010
```
1111
<Callout emoji="">
12-
```ansi
12+
```
1313
Installed pyXLMS version: 1.3.0
1414
```
1515
</Callout>

content/docs/webapp.mdx

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,17 @@ Additionally, the web application can also be run locally or self-hosted. **This
2222
- ```bash copy
2323
cd pyXLMS
2424
```
25-
- Running the [streamlit](https://streamlit.io/) app locally:
25+
- **\[Recommended\]** Running the [streamlit](https://streamlit.io/) app via [uv](https://docs.astral.sh/uv/) locally:
26+
- ```bash copy
27+
cd gui
28+
```
29+
- ```bash copy
30+
pip install uv
31+
```
32+
- ```bash copy
33+
uv run -- streamlit run streamlit_app.py
34+
```
35+
- _or_ running the [streamlit](https://streamlit.io/) app natively locally:
2636
- ```bash copy
2737
cd gui
2838
```

content/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ _a python package to process protein cross-linking data_
55

66
<div style={{ textAlign: 'justify' }}>
77

8-
<img src="https://github.com/hgb-bin-proteomics/pyXLMS/raw/master/docs/logo/logo_padded_shadow.png" alt="pyXLMS logo" align="left" width={200} style={{padding: '5px 20px 10px 0px',}}/>
8+
<Image src="/logo_padded_shadow.png" alt="pyXLMS logo" align="left" width={200} height={200} style={{padding: '5px 20px 10px 0px',}}/>
99

1010
**pyXLMS** is a python package and web application with graphical user interface that aims to simplify and streamline the intermediate step of
1111
connecting crosslink search engine results with down-stream analysis tools, enabling researchers even without bioinformatics knowledge to

public/logo.png

49.1 KB
Loading

public/logo_padded_shadow.png

55.6 KB
Loading

public/workflow.png

702 KB
Loading

0 commit comments

Comments
 (0)