<!-- TODO: Uncomment this after adding logo. -->
<!-- :::{image} _static/logo.svg -->
<!-- :class: only-light -->
<!-- :alt: McStasToX -->
<!-- :width: 60% -->
<!-- :align: center -->
<!-- ::: -->
<!-- :::{image} _static/logo-dark.svg -->
<!-- :class: only-dark -->
<!-- :alt: McStasToX -->
<!-- :width: 60% -->
<!-- :align: center -->
<!-- ::: -->
<!---->
<!-- ```{raw} html -->
<!--    <style> -->
<!--     .transparent {display: none; visibility: hidden;} -->
<!--     .transparent + a.headerlink {display: none; visibility: hidden;} -->
<!--    </style> -->
<!-- ``` -->
<!---->
<!-- ```{role} transparent -->
<!-- ``` -->

<!-- # {transparent}`McStasToX` -->
# McStasToX

<div style="font-size:1.2em;font-style:italic;color:var(--pst-color-text-muted);text-align:center;">
  Python package to read McStas data and export as python objects in different formats or as other files.


  </br></br>
</div>

:::{include} user-guide/installation.md
:heading-offset: 1
:::

## Quick Start

::::{grid} 1

:::{grid-item-card} {octicon}``eye;1em`` Quick Start with Overall Guide
:link: user-guide/overall_demo.ipynb

:::

::::

## Get in touch

- If you have questions that are not answered by these documentation pages, ask on [discussions](https://github.com/mccode-dev/mcstastox/discussions). Please include a self-contained reproducible example if possible.
- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code [on GitHub](https://github.com/mccode-dev/mcstastox).

```{toctree}
---
hidden:
---

user-guide/index
api-reference/index
developer/index
about/index
```
