Smact

<!-- Release notes generated using configuration in .github/release.yml at master -->

What's Changed
🛠 Enhancements
* Preparing new release 2.5.5 by AntObi in https://github.com/WMD-group/SMACT/pull/192
🤷‍♂️ Other Changes
* Update ci.yml by AntObi in https://github.com/WMD-group/SMACT/pull/187
* Added crystal_space example by hspark1212 in https://github.com/WMD-group/SMACT/pull/189
* Compute compound probabilities for pymatgen Structures using the `oxidation_states` module by AntObi in https://github.com/WMD-group/SMACT/pull/191


**Full Changelog**: https://github.com/WMD-group/SMACT/compare/v2.5.4...v2.5.5

<!-- Release notes generated using configuration in .github/release.yml at master -->

What's Changed
🛠 Enhancements
* Enable custom oxidation states to be used in the `smact_filter` function by AntObi in https://github.com/WMD-group/SMACT/pull/165
🤷‍♂️ Other Changes
* Fixed Readthedocs deprecating the "use system packages" feature by AntObi in https://github.com/WMD-group/SMACT/pull/156
* Python3.11 compatibility by AntObi in https://github.com/WMD-group/SMACT/pull/157
* Update README.md by AntObi in https://github.com/WMD-group/SMACT/pull/166
* Update ci.yml by AntObi in https://github.com/WMD-group/SMACT/pull/178
* compare ternary/quaternary charge state fixed by JiwooChloeLee in https://github.com/WMD-group/SMACT/pull/177
* a tiny error in eletronegativity of Zr in element_data.txt by hspark1212 in https://github.com/WMD-group/SMACT/pull/181
* Preparing v2.5.4 by AntObi in https://github.com/WMD-group/SMACT/pull/184

New Contributors
* hspark1212 made their first contribution in https://github.com/WMD-group/SMACT/pull/181

**Full Changelog**: https://github.com/WMD-group/SMACT/compare/v2.5.3...v2.5.4

What's Changed
* doper.py remove duplicates by JiwooChloeLee in https://github.com/WMD-group/SMACT/pull/136
* Bump pymatgen from 2023.6.28 to 2023.7.20 by dependabot in https://github.com/WMD-group/SMACT/pull/149
* Combined PR by github-actions in https://github.com/WMD-group/SMACT/pull/152
* Bump pytest from 7.3.1 to 7.4.0 by dependabot in https://github.com/WMD-group/SMACT/pull/148
* Bump pandas from 2.0.2 to 2.0.3 by dependabot in https://github.com/WMD-group/SMACT/pull/150
* Chloe Lee Modify doper_example and doper.py files to a newer version by JiwooChloeLee in https://github.com/WMD-group/SMACT/pull/153
* Structure updates by AntObi in https://github.com/WMD-group/SMACT/pull/154


**Full Changelog**: https://github.com/WMD-group/SMACT/compare/v2.5.2...v2.5.3

What's Changed

Main change
* Fixed bug with `smact_filter` not working with multiprocessing

Automated release notes
* Combined PR by github-actions in https://github.com/WMD-group/SMACT/pull/128
* Bump pytest from 7.2.2 to 7.3.1 by dependabot in https://github.com/WMD-group/SMACT/pull/123
* Bump numpy from 1.24.1 to 1.24.3 by dependabot in https://github.com/WMD-group/SMACT/pull/124
* Bump pre-commit from 3.2.1 to 3.2.2 by dependabot in https://github.com/WMD-group/SMACT/pull/125
* Bump pyupgrade from 3.3.1 to 3.3.2 by dependabot in https://github.com/WMD-group/SMACT/pull/127
* Combined PR by github-actions in https://github.com/WMD-group/SMACT/pull/134
* Bump pytest-subtests from 0.10.0 to 0.11.0 by dependabot in https://github.com/WMD-group/SMACT/pull/131
* Bump pre-commit from 3.2.2 to 3.3.2 by dependabot in https://github.com/WMD-group/SMACT/pull/132
* Bump nbqa from 1.6.3 to 1.7.0 by dependabot in https://github.com/WMD-group/SMACT/pull/133
* Bump pyupgrade from 3.3.2 to 3.4.0 by dependabot in https://github.com/WMD-group/SMACT/pull/130
* Pandas patch by AntObi in https://github.com/WMD-group/SMACT/pull/135
* Bump pandas from 1.5.3 to 2.0.2 by dependabot in https://github.com/WMD-group/SMACT/pull/129
* Added pytest-cov to dev requirements by AntObi in https://github.com/WMD-group/SMACT/pull/143
* Combined PR by github-actions in https://github.com/WMD-group/SMACT/pull/145
* Bump pymatgen from 2023.5.31 to 2023.6.28 by dependabot in https://github.com/WMD-group/SMACT/pull/140
* Bump pyupgrade from 3.4.0 to 3.8.0 by dependabot in https://github.com/WMD-group/SMACT/pull/144
* Bump pre-commit from 3.3.2 to 3.3.3 by dependabot in https://github.com/WMD-group/SMACT/pull/139
* Smact filter patch by AntObi in https://github.com/WMD-group/SMACT/pull/146
* Update screening.py docstrings by AntObi in https://github.com/WMD-group/SMACT/pull/147


**Full Changelog**: https://github.com/WMD-group/SMACT/compare/v2.5.1...v2.5.2

What's Changed

Main update
* Smact filter by AntObi in https://github.com/WMD-group/SMACT/pull/122
The `smact_filter` function now takes a `stoichs` argument which allows users to supply a list of stoichiometric ratios to be considered for generating charge-neutral compositions.

All updates
* Combined PR by github-actions in https://github.com/WMD-group/SMACT/pull/96
* Bump numpy from 1.24.0 to 1.24.1 by dependabot in https://github.com/WMD-group/SMACT/pull/92
* Bump pandas from 1.5.0 to 1.5.2 by dependabot in https://github.com/WMD-group/SMACT/pull/93
* Bump pre-commit from 2.20.0 to 2.21.0 by dependabot in https://github.com/WMD-group/SMACT/pull/94
* Bump nbqa from 1.5.3 to 1.6.0 by dependabot in https://github.com/WMD-group/SMACT/pull/95
* Bump scipy from 1.9.1 to 1.9.3 by dependabot in https://github.com/WMD-group/SMACT/pull/91
* Code coverage by AntObi in https://github.com/WMD-group/SMACT/pull/97
* future v 0.18.2 -> 0.18.3 by dandavies99 in https://github.com/WMD-group/SMACT/pull/98
* update pre-commit-config.yaml by AntObi in https://github.com/WMD-group/SMACT/pull/105
* Combined PR by github-actions in https://github.com/WMD-group/SMACT/pull/106
* Bump nbqa from 1.6.0 to 1.6.1 by dependabot in https://github.com/WMD-group/SMACT/pull/103
* Bump scipy from 1.9.3 to 1.10.0 by dependabot in https://github.com/WMD-group/SMACT/pull/99
* Bump pre-commit from 2.21.0 to 3.0.2 by dependabot in https://github.com/WMD-group/SMACT/pull/102
* Combined PR by github-actions in https://github.com/WMD-group/SMACT/pull/107
* Bump pytest from 7.2.0 to 7.2.1 by dependabot in https://github.com/WMD-group/SMACT/pull/100
* Bump black from 22.12.0 to 23.1.0 by dependabot in https://github.com/WMD-group/SMACT/pull/101
* Combined PR by github-actions in https://github.com/WMD-group/SMACT/pull/113
* Bump scipy from 1.10.0 to 1.10.1 by dependabot in https://github.com/WMD-group/SMACT/pull/108
* Bump pytest-subtests from 0.9.0 to 0.10.0 by dependabot in https://github.com/WMD-group/SMACT/pull/109
* Bump pre-commit from 3.0.2 to 3.1.1 by dependabot in https://github.com/WMD-group/SMACT/pull/110
* Bump nbqa from 1.6.1 to 1.6.3 by dependabot in https://github.com/WMD-group/SMACT/pull/111
* Bump isort from 5.11.4 to 5.12.0 by dependabot in https://github.com/WMD-group/SMACT/pull/112
* Combined PR by github-actions in https://github.com/WMD-group/SMACT/pull/119
* Bump black from 23.1.0 to 23.3.0 by dependabot in https://github.com/WMD-group/SMACT/pull/115
* Bump pandas from 1.5.2 to 1.5.3 by dependabot in https://github.com/WMD-group/SMACT/pull/117
* Bump pytest from 7.2.1 to 7.2.2 by dependabot in https://github.com/WMD-group/SMACT/pull/118
* Combined PR by github-actions in https://github.com/WMD-group/SMACT/pull/120
* Bump pre-commit from 3.1.1 to 3.2.1 by dependabot in https://github.com/WMD-group/SMACT/pull/114
* Bump pymatgen from 2022.11.7 to 2023.3.23 by dependabot in https://github.com/WMD-group/SMACT/pull/116
* Smact filter by AntObi in https://github.com/WMD-group/SMACT/pull/122



**Full Changelog**: https://github.com/WMD-group/SMACT/compare/v2.5.0...v2.5.1

What's Changed
* /Users/jiwoolee by JiwooChloeLee in https://github.com/WMD-group/SMACT/pull/79
* CI updates by AntObi in https://github.com/WMD-group/SMACT/pull/80
* Combined PR by github-actions in https://github.com/WMD-group/SMACT/pull/86
* Bump pathos from 0.2.9 to 0.3.0 by dependabot in https://github.com/WMD-group/SMACT/pull/81
* Bump spglib from 1.16.5 to 2.0.2 by dependabot in https://github.com/WMD-group/SMACT/pull/82
* Bump isort from 5.11.2 to 5.11.4 by dependabot in https://github.com/WMD-group/SMACT/pull/83
* Bump numpy from 1.23.3 to 1.24.0 by dependabot in https://github.com/WMD-group/SMACT/pull/84
* Bump pymatgen from 2022.9.21 to 2022.11.7 by dependabot in https://github.com/WMD-group/SMACT/pull/85
* Mp api updates by AntObi in https://github.com/WMD-group/SMACT/pull/87
* Usage and doc updates by AntObi in https://github.com/WMD-group/SMACT/pull/88
* updated README.md and setup.py by AntObi in https://github.com/WMD-group/SMACT/pull/89
* Update setup.py by AntObi in https://github.com/WMD-group/SMACT/pull/90

New Contributors
* github-actions made their first contribution in https://github.com/WMD-group/SMACT/pull/86
* dependabot made their first contribution in https://github.com/WMD-group/SMACT/pull/81

**Full Changelog**: https://github.com/WMD-group/SMACT/compare/v2.4.2...v2.5.0