Metadata-Version: 2.4
Name: jinwu
Version: 0.0.24
Summary: Joint inference and physical modeling toolkit for high-energy transient light-curve and spectral analysis.
Author-email: Xinxiang Sun <sunxx@nao.cas.cn>
License: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/xinxiangsun/jinwu
Project-URL: Repository, https://github.com/xinxiangsun/jinwu
Project-URL: Documentation, https://github.com/xinxiangsun/jinwu/blob/master/README.md
Keywords: astrophysics,transient,lightcurve,spectral,modeling,jinwu
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: astropy>=7.1.0
Requires-Dist: emcee
Requires-Dist: bxa
Requires-Dist: pymc
Requires-Dist: swiftbat
Requires-Dist: regions
Requires-Dist: ipyaladin
Requires-Dist: requests
Requires-Dist: pillow
Dynamic: license-file

# 安装方式 / Installation

### 通过 PyPI 安装

```bash
pip install jinwu
```

# JinWu：Joint Inference for high energy transient light‑curve & spectral analysis With Unifying physical modeling

## 项目简介 / Project Introduction

金乌（JinWu）是中国古代神话中的太阳神鸟，象征着光明、能量与希望。传说中，金乌为三足乌，栖于扶桑，驾驭太阳穿行于天际，赋予万物生机。以“金乌”为名，寓意本项目致力于高能瞬变天体（如伽马暴、超新星等）的联合光变曲线与光谱物理建模与推断，探索宇宙中最明亮、最剧烈的能量释放过程。

本项目旨在为高能天体物理领域的研究者，提供统一、灵活且易于扩展的分析工具，支持多种物理模型、数据拟合与推断方法，促进科学交流与创新。

JinWu, the Golden Crow, is a legendary solar bird in ancient Chinese mythology, symbolizing light, energy, and hope. According to legend, JinWu is a three-legged bird dwelling in Fusang, driving the sun across the sky and bringing vitality to all things. Naming this project "JinWu" reflects our dedication to joint inference and physical modeling of high-energy transients (such as gamma-ray bursts and supernovae), aiming to explore the brightest and most energetic phenomena in the universe.

This project provides a unified, flexible, and extensible toolkit for researchers and enthusiasts in high-energy astrophysics, supporting various physical models, data fitting, and inference methods, and fostering scientific communication and innovation.

### 源码安装

```bash
git clone https://github.com/Charon0922/jinwu.git
cd jinwu
pip install .
```

### 必要依赖 / Required Dependencies

本包依赖以下 Python 库，请确保已安装：

- numpy
- scipy
- astropy
- emcee/pymc
- astro-gdt

### Fermi GBM Response Generator

> git clone [https://github.com/xinxiangsun/responsum.git](https://github.com/xinxiangsun/responsum.git)

> pip install ./responsum

> git clone [https://github.com/xinxiangsun/gbmgeometry.git](https://github.com/xinxiangsun/gbmgeometry.git)

> pip install ./gbmgeometry
>
> git clone [https://github.com/xinxiangsun/gbm_drm_gen.git](https://github.com/xinxiangsun/gbm_drm_gen.git)

> pip install ./gbm_drm_gen

> git clone https://github.com/xinxiangsun/hea.git

> pip install ./hea

## License / 许可证

This project is licensed under the GNU General Public License v3.0 or later (GPL-3.0-or-later). See the `LICENSE` file for the full text.

本项目采用 GNU 通用公共许可证第 3 版或更高版本（GPL-3.0-or-later）授权。详见根目录的 `LICENSE` 文件。

SPDX identifier (optional for source headers): `SPDX-License-Identifier: GPL-3.0-or-later`.

### Copyright

推荐在可交互程序启动时或源文件头部加入如下声明：

```
JinWu — Copyright (C) 2025 Xinxiang Sun

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```

或使用 SPDX 简洁标识：

```
# SPDX-License-Identifier: GPL-3.0-or-later
```

## Acknowledgments

This project incorporates code modified from [heapy](https://github.com/jyangch/heapy) (https://github.com/jyangch/heapy)

by Jun Yang, licensed under GPLv3.
