# Welcome to RAIMAD!

RAIMAD is a parametric 2D CAD program
for designing on-chip astronomical mask files.

- GitHub: [tifuun/raimad](https://github.com/tifuun/raimad)
- Install: `pip install raimad` or read the [instructions](pages/install.md)
- Start working: [[tutorial.md]]

<!--
Start reading at [Installing RAIMAD](pages/install.md)
or [browse the map of all pages](map.md).
Are you a TIFUUN collaborator?
Visit the [TIFUUN collaborator welcome page](pages/tifuun.md)!

<nav id="navgrid">
    <a href="pages/tutorial.html">
        <i class="fa-solid fa-graduation-cap icon"></i>
        <h3>Tutorial</h3>
        Learn RAIMAD step-by-step
    </a>
    <a href="map.html">
        <img
            src="img/doc/map-traced.svg"
            alt="map icon"
            class="icon"
            >
        <h3>Map</h3>
        Browse the map of all RAIDOC pages
    </a>
    <a href="pages/tifuun.html">
        <img
            src="img/doc/tifuun-mono.svg"
            alt="tifuun icon"
            class="icon"
            >
        <h3>TIFUUN</h3>
        Are you a TIFUUN collaborator?
        Read the welcome page!
    </a>
    <a href="pages/contributor-guide.html">
        <i class="fa-solid fa-code icon"></i>
        <h3>Contribute</h3>
        Want to contiribute to RAIMAD?
        Check the Contributor's guide!
    </a>
</nav>

-->

## Offline Access and Old Versions

Archives of the current and previous versions of this
documentation can be found on the
[Github releases page](https://github.com/tifuun/raidoc/releases).
After extracting the archive, open the contained `index.html`

## Existing components

There are several existing RAIMAD components which
you can browse in [RAIDEX](https://tifuun.github.io/raidex/).
Most of them are available on the
[`rai_compos_pub`](https://github.com/tifuun/rai_compos_pub)
repository,
which is also home to a "toy" version of the DESHIMA2.0 spectrometer chip,
one of the most complex RAIMAD components currently available.
The [Vialess MSL page](pages/vialess-msl.md) contains a step-by-step
guide on creating a component of medium complexity.