Metadata-Version: 2.1
Name: ifg
Version: 2.2.3
Summary: Calculator of Ideal Fermi gas properties
Home-page: https://github.com/alekseik1/ifg-py
License: MIT
Author: Aleksei Kozharin
Author-email: 1alekseik1@gmail.com
Maintainer: Aleksei Kozharin
Maintainer-email: 1alekseik1@gmail.com
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
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: fdint_py3 (>=2.0.2,<3.0.0)
Requires-Dist: numpy (>=1.13.3,<=1.17.3) ; python_version >= "3.5" and python_version < "3.6"
Requires-Dist: numpy (>=1.14.5,<=1.19.3) ; python_version >= "3.6" and python_version < "3.7"
Requires-Dist: numpy (>=1.16.5,<=1.20) ; python_version >= "3.7" and python_version < "3.8"
Requires-Dist: numpy (>=1.17.3,<1.24.0) ; python_version >= "3.8" and python_version < "3.9"
Requires-Dist: numpy (>=1.22.4,<2.0.0) ; python_version >= "3.9" and python_version < "4.0"
Requires-Dist: numpy (>=1.8.2,<=1.16) ; python_version >= "2.7" and python_version < "3.5"
Project-URL: Documentation, https://ifg-py.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/alekseik1/ifg-py
Description-Content-Type: text/markdown

# Numerical ideal Fermi gas

[![Documentation Status](https://readthedocs.org/projects/ifg-py/badge/?version=latest)](https://ifg-py.readthedocs.io/en/latest/?badge=latest)
[![tests](https://github.com/alekseik1/ifg-py/workflows/tests/badge.svg?branch=master)](https://github.com/alekseik1/ifg-py/actions?query=workflow%3A%22tests%22)
[![examples](https://github.com/alekseik1/ifg-py/workflows/examples/badge.svg?branch=master)](https://github.com/alekseik1/ifg-py/actions?query=workflow%3A%22examples%22)
[![CodeQL](https://github.com/alekseik1/ifg-py/workflows/CodeQL/badge.svg?branch=master)](https://github.com/alekseik1/ifg-py/actions?query=workflow%3A%22CodeQL%22)
[![build and deploy](https://github.com/alekseik1/ifg-py/workflows/build%20and%20deploy/badge.svg?branch=master)](https://github.com/alekseik1/ifg-py/actions)
[![codecov](https://codecov.io/gh/alekseik1/ifg-py/branch/master/graph/badge.svg?token=45T6I5O81G)](https://codecov.io/gh/alekseik1/ifg-py)

## Getting started
```bash
pip install ifg
```

## Functionality
The module can calculate some properties (like pressure, entropy) for ideal Fermi gas model.

See [API reference](https://ifg-py.readthedocs.io/en/latest/) for more information


## Examples
See `examples/` folder for plots and code examples.

## Acknowledgements
- [Library for Fermi integrals](https://pypi.org/project/fdint/)


## Reporting bugs
Use *Issues* to report any errors or bugs.

