% haniwers documentation master file, created by
% sphinx-quickstart on Sun Jun  5 09:07:09 2022.
% You can adapt this file completely to your liking,
% but it should at least contain the root `toctree` directive.

# haniwers ドキュメント

![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**は、TanQ/FunQプロジェクト向けの宇宙線検出器OSECHIのデータ取得・解析ツールです。

---

## 🚀 はじめての方へ

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

1. **[クイックスタート](quickstart.md)** ← **ここから始める！**（10分で最初の測定）
2. **[インストールガイド](users/installation.md)**（詳しいインストール方法）
3. **[ユーザーガイド](users/index.md)**（基本的な使用方法）

## 📚 メインドキュメント

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

```{toctree}
---
maxdepth: 2
caption: 💫 宇宙線を測定したい
---
users/index.md
```

```{toctree}
---
maxdepth: 2
caption: 📊 データを解析したい
---
collaborators/index
setup/index
```

```{toctree}
---
maxdepth: 2
caption: 💻 コードを改善したい
---
developers/index
apidocs/index
```

```{toctree}
---
maxdepth: 2
caption: 📝 リリース情報
---
releases/index
```

```{toctree}
---
maxdepth: 2
caption: 📚 ドキュメント一覧
---
users/index
collaborators/index
developers/index
_shared/glossary
_shared/commands
```

## 📖 詳細ガイド

### ユーザー向け：CLIコマンドの使い方

```{toctree}
---
maxdepth: 1
caption: コマンドリファレンス
---
command/index
```

### 開発者向け：Python API リファレンス

```{toctree}
---
maxdepth: 1
caption: API ドキュメント
---
apidocs/index
```

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

## 🔗 リンク

- **PyPI**: [https://pypi.org/project/haniwers/](https://pypi.org/project/haniwers/)
- **GitLab リポジトリ**: [https://gitlab.com/qumasan/haniwers](https://gitlab.com/qumasan/haniwers)
- **Issues**: [バグ報告・機能要望](https://gitlab.com/qumasan/haniwers/-/issues)

## 📈 プロジェクト統計

### 開発状況

![GitLab Last Commit](https://img.shields.io/gitlab/last-commit/qumasan%2Fhaniwers?style=for-the-badge)
![Gitlab Pipeline Status](https://img.shields.io/gitlab/pipeline-status/qumasan%2Fhaniwers?style=for-the-badge)

### ダウンロード統計

![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)

---

% # Indices and tables
% - {ref}`genindex`
% - {ref}`modindex`
% - {ref}`search`