# haniwers ドキュメント（v0 ブランチ）

![GitLab Tag](https://img.shields.io/gitlab/v/tag/qumasan%2Fhaniwers?sort=semver&style=for-the-badge)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/haniwers?style=for-the-badge)
![GitLab License](https://img.shields.io/gitlab/license/qumasan%2Fhaniwers?style=for-the-badge)

**haniwers**は小型宇宙線検出器OSECHIを使ったTanQ/FunQプロジェクトのデータ取得・解析をサポートするPython製のツールです。

:::{admonition} このドキュメントについて
:class: warning

このドキュメントは**v0ブランチ専用**です。
v0ブランチの開発は2025年10月に凍結し、基本的には**ドキュメント更新のみ**の運用としています。
新機能については
[mainブランチ](https://gitlab.com/qumasan/haniwers)
を参照してください。
:::

:::{admonition} 対応する`kurikintons`

[kurikintons](https://gitlab.com/osechi/kurikintons)は
OSECHIで検出した宇宙線の信号処理を担うファームウェアです。

`haniwers`の`v0`系を使う場合には、
`kurikintons`の`v0:build`を利用してください。
導入については`kurikintons`のドキュメントを参照してください。

:::

## 🚀 はじめての方へ

新しいユーザーは、以下の順序で読むことをオススメします：

1. **[クイックスタート](quickstart.md)** ← **ここから始める！**（10分で最初の測定）
2. **[インストールガイド](install.md)**（詳しいインストール方法）
3. **[ユーザーガイド](user/index.md)**（基本的な使用方法）
4. **[コマンドリファレンス](command/index.md)**（全コマンド詳細）

## 📚 ドキュメント目次

```{toctree}
---
maxdepth: 1
caption: スタートガイド
---
quickstart
install
```

```{toctree}
---
maxdepth: 2
caption: ユーザー向けドキュメント
---
user/index
usage/index
command/index
config/index
```

```{toctree}
---
maxdepth: 1
caption: その他
---
notes/index
```

## 🔗 リンク

- **[PyPI](https://pypi.org/project/haniwers/)** - パッケージダウンロード
- **[GitLabリポジトリ](https://gitlab.com/qumasan/haniwers)** - ソースコード・v1開発
- **[Issues](https://gitlab.com/qumasan/haniwers/-/issues)** - バグ報告・質問

## 📊 ダウンロード統計

![PyPI - Downloads](https://img.shields.io/pypi/dd/haniwers?style=for-the-badge)
![PyPI -Downloads](https://img.shields.io/pypi/dw/haniwers?style=for-the-badge)
![PyPI - Downloads](https://img.shields.io/pypi/dm/haniwers?style=for-the-badge)

---

## 🤝 貢献・開発について

v0ブランチはドキュメント更新のみです。

- **ドキュメント改善**: v0ブランチで受け付けています（[CLAUDE.md](https://gitlab.com/qumasan/haniwers/-/blob/v0/CLAUDE.md)参照）
- **新機能・コード修正**: [mainブランチ](https://gitlab.com/qumasan/haniwers)で開発中
- **v1開発**: 次世代版の開発が進行中です