Metadata-Version: 2.4
Name: axionbloch
Version: 0.2.3
Summary: Simulation tool for axion-induced spin dynamics.
Author-email: Yuzhe Zhang <yuhzhang@uni-mainz.de>
License-Expression: MIT
Project-URL: Documentation, https://axionbloch.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/Yuzhe98/AxionBloch
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: astropy
Requires-Dist: scipy
Requires-Dist: h5py
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: black>=23.0; extra == "dev"
Requires-Dist: ruff>=0.1; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=5.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.0; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=1.0; extra == "docs"
Provides-Extra: test
Requires-Dist: pytest>=7.0; extra == "test"
Requires-Dist: pytest-cov>=4.0; extra == "test"
Dynamic: license-file

# AxionBloch
A package for simulating **axion**-induced spin dynamics based on **Bloch equations**, implemented in **Python**  and **C++**. 

Yuzhe Zhang - GSI HIM & Uni Mainz - yuhzhang@uni-mainz.de

📖 Documentation: [axionbloch.readthedocs.io](https://axionbloch.readthedocs.io/en/latest/)

## Features

In AxionBloch, the axion (including axionlike-particle or ALP) field acts like a **pseudomagnetic field** coupling to (nuclear) spins.

The package provides a **numerical platform** to study these subtle effects using Bloch-equation-based simulations.

## Requirements

- Python >= 3.10

### Dependencies

- **numpy** — Numerical computing
- **scipy** — Scientific computing and numerical integration
- **matplotlib** — Plotting and visualization
- **astropy** — Astronomical utilities
- **h5py** — HDF5 file I/O

## Installation

Install from [PyPI](https://pypi.org/project/axionbloch/):
```bash
pip install axionbloch
```

Or build and install from source (requires a C++17 compiler for the simulation extension):
```bash
git clone https://github.com/Yuzhe98/AxionBloch.git
cd AxionBloch
pip install .
```

## Quick Start
Examples can be found in the examples/.

## License
Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)
