diff --git a/README.md b/README.md index ad3e54cd..c19e18c8 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,6 @@ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hyppo?style=flat)](https://pypi.org/project/hyppo/) [![PyPI](https://img.shields.io/pypi/v/hyppo?style=flat)](https://pypi.org/project/hyppo/) [![arXivshield](https://img.shields.io/badge/arXiv-1907.02088-red.svg?style=flat)](https://arxiv.org/abs/1907.02088) -[![All Contributors][all-contrib]](#contributors) hyppo (**HYP**othesis Testing in **P**yth**O**n, pronounced "Hippo") is an open-source software package for multivariate hypothesis testing. We decided to develop hyppo for the following reasons: @@ -26,7 +25,7 @@ Website: [https://hyppo.neurodata.io/](https://hyppo.neurodata.io/) hyppo requires the following: -* [python](https://www.python.org/) (>= 3.6) +* [python](https://www.python.org/) (>= 3.8) * [numba](https://numba.pydata.org/) (>= 0.46) * [numpy](https://numpy.org/) (>= 1.17) * [scipy](https://docs.scipy.org/doc/scipy/reference/) (>= 1.4.0) @@ -71,74 +70,16 @@ has detailed information about contributing code, documentation, and tests. ## Contributors -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Sambit Panda
Sambit Panda

🐛 💻 📖 🤔 🚧 👀
cshen6
cshen6

🤔
joshua vogelstein
joshua vogelstein

🔍 🧑‍🏫 🤔
Satish Palaniappan
Satish Palaniappan

💻 🤔
Junhao Xiong
Junhao Xiong

💻 🤔
Eric Bridgeford
Eric Bridgeford

🐛 🤔
Ronak D. Mehta
Ronak D. Mehta

💻 🤔
Jaewon Chung
Jaewon Chung

🐛 💻 📖
Jayanta Dey
Jayanta Dey

💻
Bijan Varjavand
Bijan Varjavand

💻
Benjamin Pedigo
Benjamin Pedigo

🐛 💻
alyakin314
alyakin314

💻 🤔
Vivek Gopalakrishnan
Vivek Gopalakrishnan

💻
Ronan Perry
Ronan Perry

🐛 💻 🤔 👀 📖
Haoyin Xu
Haoyin Xu

💻 📖 👀
Hadas Arik
Hadas Arik

💻
kareef928
kareef928

💻
Verathagnus
Verathagnus

💻
dlee0156
dlee0156

💻
Najmieh Sadat Safarabadi
Najmieh Sadat Safarabadi

📖
TacticalFallacy
TacticalFallacy

💻
darsh-patel
darsh-patel

💻
zdbzdb123123
zdbzdb123123

💻
MatthewZhao26
MatthewZhao26

💻
Alexander Oakley
Alexander Oakley

📖
Harsh Gupta
Harsh Gupta

📖
Prabhat Kr. Gupta
Prabhat Kr. Gupta

🐛
Victoria Shevchenko
Victoria Shevchenko

💻
saivythik
saivythik

📖 🐛
Shruti Naik
Shruti Naik

📖
Praveen Prasad
Praveen Prasad

📖
Jennifer Tam
Jennifer Tam

📖
PoojaMandal
PoojaMandal

📖
Satarupa Deb
Satarupa Deb

📖
Alex1-ai
Alex1-ai

📖
Vatsalya Vyas
Vatsalya Vyas

📖
- - - - - - -This project follows the [all-contributors](https://allcontributors.org) specification. -Contributions of any kind are welcome! +Thanks goes to these wonderful people: + + + + + +Made with [contrib.rocks](https://contrib.rocks). ## Project History hyppo is a rebranding of mgcpy, which was founded in November 2018. -mgcpy was designed and written by @tpsatish95, @sampan501, @junhaobearxiong, @sundaysundya, @ananyas713, and @ronakdm. hyppo -was designed and written by Sambit Panda and first released in February 2020. +mgcpy was designed and written by [@tpsatish95](https://github.com/tpsatish95), [@sampan501](https://github.com/sampan501), [@junhaobearxiong](https://github.com/junhaobearxiong), [@sundaysundya](https://github.com/sundaysundya), [@ananyas713](https://github.com/ananyas713), and [@ronakdm](https://github.com/ronakdm). hyppo +was designed and written by [@sampan501](https://github.com/sampan501) and first released in February 2020. diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst index 52019153..0b4077f6 100644 --- a/docs/changelog/index.rst +++ b/docs/changelog/index.rst @@ -6,6 +6,7 @@ This is the list of changes to hyppo between each release. For full details, see .. toctree:: :maxdepth: 1 + v0.5.0.md v0.4.0.md v0.3.2.md v0.3.1.md diff --git a/docs/changelog/v0.4.0.md b/docs/changelog/v0.4.0.md index 3e925cbb..e502133c 100644 --- a/docs/changelog/v0.4.0.md +++ b/docs/changelog/v0.4.0.md @@ -1,7 +1,5 @@ # hyppo v0.4.0 -> **Note:** hyppo v0.4.0 has not been released yet! - ## Highlights of this release hyppo v0.4.0 is the culmination of 12 months of hard work. It contains @@ -10,7 +8,7 @@ documentation. All users are encouraged to upgrade to this release, as there are a large number of bug-fixes and optimizations. -This release requires Python 3.6+. +This release requires Python 3.8+. ## New features diff --git a/docs/changelog/v0.5.0.md b/docs/changelog/v0.5.0.md new file mode 100644 index 00000000..ff2f3c5c --- /dev/null +++ b/docs/changelog/v0.5.0.md @@ -0,0 +1,39 @@ +# hyppo v0.5.0 + +## Highlights of this release + +hyppo v0.5.0 is the culmination of 16 months of hard work. It contains +many new features, numerous bug-fixes, improved test coverage and better +documentation. All users are encouraged to +upgrade to this release, as there are a large number of bug-fixes and +optimizations. + +This release requires Python 3.8+. + +## New features + +* Add Conditional Dcorr +* Add Partial Dcorr +* Add Partial Correlation + +## Bug fixes + +* Fixed fast KMERF stat/pvalue so not always significant +* Biased Dcorr test statistic has been corrected + +## Documentation + +* Fixed documentation rendering issues +* Fixed typos in various docstrings +* Added new license +* Improved contributing guidelines +* Added code of conduct + +## Maintenance + +* Move Friedman Rafsky from hyppo.ksample to hyppo.independence + +## Full Changelog + +[v0.4.0...v0.5.0](https://github.com/neurodata/hyppo/compare/v0.4.0...v0.5.0) + diff --git a/hyppo/__init__.py b/hyppo/__init__.py index 5ea4e7dd..e9c46464 100644 --- a/hyppo/__init__.py +++ b/hyppo/__init__.py @@ -7,4 +7,4 @@ import hyppo.d_variate import hyppo.conditional -__version__ = "0.4.0" +__version__ = "0.5.0" diff --git a/setup.py b/setup.py index ba25c9dd..b2fb927e 100644 --- a/setup.py +++ b/setup.py @@ -75,19 +75,18 @@ def run(self): author_email=AUTHOR_EMAIL, install_requires=REQUIRED_PACKAGES, url=URL, - license="MIT", + license="PolyForm Noncommercial License 1.0.0", classifiers=[ "Development Status :: 3 - Alpha", "Intended Audience :: Science/Research", "Topic :: Scientific/Engineering :: Mathematics", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.6", - "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", ], packages=find_packages(), include_package_data=True,