<!-- # Home

## 套件簡介

本套件用來分析FLASH code跑出來的模擬結果，並且強調好用性，讓你可以透過最簡單直覺的方式來使用本套件。你只需要一行function call，按照IDE的提示填入input，就可以輕鬆地計算出結果。

本套件是透過整合並擴充yt模組開發出來的，且已經被撰寫成好維護、好拓展的分層式軟體架構。

### 支援分析的項目

| | 用途 | Velocity filtering | Los velocity dispersion | Turbulence heating | Radiative cooling | Other yt fields(\*1) |
| -------------- | ------------------------ | ------------------ | ----------------------- | ------------------ | ----------------- | --------------- |
| Data3dAnalyzor | 3D數據 | V | | V | | |
| Data2dAnalyzor | 2D slice數據 | V | V | V | | |
| Data1dAnalyzor | Profile或Time Series數據 | V | | V | V | V |
| Plot2d | 2D Map作圖 | V | V | V | | |
| Plot1d | Profile或Time Series作圖 | | | V | V | V |

備註：
\*1 可用本套件來呼叫yt模組。舉例而言，你可以透過本套件來畫出`("gas", "temperature")`這個field的profile。

## 目錄

* [Getting Started](/pGASdpjgTliNKcHLnYnzwA)
* [Simulation Files](/PkJFQe7YS1aQIj4EiKtQVQ)
* [Data3d Analyzor](/BOB_YlxGRtGxXLnVdd9JZQ)
* [For Developer](/zRJtFbMlSku1haXbX-H3JQ) -->

# Home

## Package Overview

This package is designed to analyze simulation results generated by the **FLASH**, **Gamer** and etc, with a strong emphasis on **ease of use**. You can perform complex computations with just a **single function call**, simply by following your IDE’s input suggestions.

The package is built by integrating and extending the `yt` module. It follows a **layered software architecture** that ensures easy maintenance and extensibility.

### Supported Features

The following table shows what kinds of analyses are supported by each module:

| Module | Purpose | Velocity Filtering | LOS Velocity Dispersion | Turbulence Heating | Radiative Cooling | Other `yt` Fields (\*1) |
| -------------- | --------------------------- | ------------------ | ----------------------- | ------------------ | ----------------- | ----------------------- |
| [Data3dAnalyzor](/BOB_YlxGRtGxXLnVdd9JZQ) | 3D data analysis | V | | V | | |
| Data2dAnalyzor | 2D slice data | V | V | V | | |
| Data1dAnalyzor | Profile / Time Series data | V | | V | V | V |
| [Plot2d](/hJKLLX5FS6SumSqh4qilig) | 2D map plotting | V | V | V | | |
| Plot1d | Profile / Time Series plots | | | V | V | V |

> \*1: This package can also be used to call `yt` fields directly.
> For example, you can easily generate a profile of the `("gas", "temperature")` field using this package.

## Documentation Index

* [Getting Started](/pGASdpjgTliNKcHLnYnzwA)
Introduction to installation, environment setup, and core usage principles.

* [Yi-Huan's Module Tutorial 2025.06.30](/OBbJyBk7REaSvrDNsYuYNg)
A tutorial with lots of examples on how to use this module.

* [Simulation Files](/PkJFQe7YS1aQIj4EiKtQVQ)
Guide on how to prepare and structure your simulation files for analysis.

* [Autosaving](/VfOrX5s2TwChRRFoDnUcRQ)
Explains the built-in caching mechanism that prevents redundant computations and how to force recalculation.

* [Data3dAnalyzor](/BOB_YlxGRtGxXLnVdd9JZQ)
Documentation of the 3D data analysis module.

* [Plot2d](/hJKLLX5FS6SumSqh4qilig)
Documentation of the 2D analyzed data ploting module.

* [For Developer](/zRJtFbMlSku1haXbX-H3JQ)
Developer notes for contributors interested in extending or maintaining the package.