# STARNet Documentation

## A unified framework for spatial multi-omics gene regulatory network inference

![STARNet](img/figure1_tutorials.png)

**STARNet** (**S**pa**T**i**A**l RNA-ATAC-seq gene **R**egulatory **Net**work) is a computational framework designed to decipher spatially specific gene regulatory networks (GRNs) from spatial RNA-ATAC-seq data.

If you find STARNet useful for your research, please consider citing our [preprint](https://www.biorxiv.org/content/10.1101/2025.08.21.671434v2).

::::{grid} 1 2 3 3
:gutter: 2

:::{grid-item-card} Installation {octicon}`plug;1em;`
:link: installation_guide
:link-type: doc

New to STARNet? Set up your environment with conda and pip.
:::

:::{grid-item-card} Tutorials {octicon}`play;1em;`
:link: tutorials/index
:link-type: doc

Step-by-step tutorials covering GRN inference across datasets and downstream applications.
:::

:::{grid-item-card} API Reference {octicon}`book;1em;`
:link: api/index
:link-type: doc

Detailed description of every public module, class, and function in STARNet.
:::

:::{grid-item-card} Release Notes {octicon}`note;1em;`
:link: Release_notes
:link-type: doc

Track the latest updates, new features, and bug fixes in STARNet.
:::

:::{grid-item-card} Developer Guide {octicon}`tools;1em;`
:link: Developer_guild
:link-type: doc

Contributing guidelines, coding standards, and development workflows.
:::

:::{grid-item-card} GitHub {octicon}`mark-github;1em;`
:link: https://github.com/DBinary/STARNet

Find a bug? Interested in contributing? Check out our GitHub repository.
:::

::::

---

## Contact

- [Lei Hu](https://dbinary.github.io) ([hulei@westlake.edu.cn](mailto:hulei@westlake.edu.cn))
- Shichen Zhang ([zhangshichen@westlake.edu.cn](mailto:zhangshichen@westlake.edu.cn))
- [Xuting Zhang](https://lxzcpro.github.io/) ([zhangxuting@westlake.edu.cn](mailto:zhangxuting@westlake.edu.cn))
- Yihai Luo ([luoyihai@westlake.edu.cn](mailto:luoyihai@westlake.edu.cn))

```{toctree}
:hidden: true
:maxdepth: 3
:titlesonly: true

installation_guide
tutorials/index
api/index
Release_notes
Developer_guild
GitHub <https://github.com/DBinary/STARNet>
```