Metadata-Version: 2.1
Name: pams
Version: 0.2.1
Summary: PAMS: Platform for Artificial Market Simulations
License: EPL-1.0
Author: Masanori HIRANO
Author-email: masa.hirano.1996@gmail.com
Requires-Python: >=3.8.1,<4.0.0
Classifier: License :: OSI Approved :: Eclipse Public License 1.0 (EPL-1.0)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: numpy (>=1.23.4,<2.0.0)
Requires-Dist: scipy (>=1.9.2,<2.0.0)
Requires-Dist: tqdm (>=4.64.1,<5.0.0)
Description-Content-Type: text/markdown

# pams
PAMS: Platform for Artificial Market Simulations

[![python](https://img.shields.io/pypi/pyversions/pams.svg)](https://pypi.org/project/pams)
[![pypi](https://img.shields.io/pypi/v/pams.svg)](https://pypi.org/project/pams)
[![CI](https://github.com/masanorihirano/pams/actions/workflows/ci-python.yml/badge.svg)](https://github.com/masanorihirano/pams/actions/workflows/ci-python.yml)
[![downloads](https://img.shields.io/pypi/dm/pams)](https://pypi.org/project/pams)
[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/18ed1eecc4f34a99bb6fd9a7160f78ca)](https://www.codacy.com/gh/masanorihirano/pams/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=masanorihirano/pams&amp;utm_campaign=Badge_Grade)
[![codecov](https://codecov.io/gh/masanorihirano/pams/branch/main/graph/badge.svg?token=tFccElw7Wd)](https://codecov.io/gh/masanorihirano/pams)

## Documentations & User Guides

Documentations are available on [readthedoc](https://pams.hirano.dev/)

## Install
This package is available on pypi as [`pams`](https://pypi.org/project/pams/)
```bash
$ pip install pams
$ python
>> import pams
```

## Citation
If you consider cite our work, please use the following [arxiv entry](https://arxiv.org/abs/2309.10729):
```bibtex
@misc{Hirano2023-pams,
    title={{PAMS: Platform for Artificial Market Simulations}},
    author={Masanori HIRANO, Ryosuke TAKATA, Kiyoshi IZUMI},
    year={2023},
    doi = {10.48550/arXiv.2309.10729}
}
```
https://arxiv.org/abs/2309.10729

If you prefer to cite this package directly, please use the following bibtex entry:
```bibtex
@misc{Hirano2022-pams,
    title={{PAMS: Platform for Artificial Market Simulations}},
    author={Masanori HIRANO, Ryosuke TAKATA, Kiyoshi IZUMI},
    year={2022},
    url = {https://github.com/masanorihirano/pams}
}
```

## Issues and Contribution
About issues (bugs):
-   You can report issues [here](https://github.com/masanorihirano/pams/issues).
-   There are no guarantee to support or fix those issues.

Contributions:
-   You can send pull requests (PRs) to this repository.
-   But, there are no guarantee to merge your PRs.


