Skip to content

Commit

Permalink
version 2.0.0 with PyPI compatability, now that statsmodels 0.12.x is…
Browse files Browse the repository at this point in the history
… released
  • Loading branch information
Ray Pomponio authored and Ray Pomponio committed May 13, 2021
1 parent 5f89ab6 commit 50ff4b1
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 9 deletions.
25 changes: 25 additions & 0 deletions .setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[metadata]
# replace with your username:
name = neuroHarmonize
version = 2.0.0
author = Raymond Pomponio
author_email = [email protected]
description = Harmonization tools for multi-center neuroimaging studies.
long_description = file: README.rst
long_description_content_type = text/markdown
url = https://github.com/rpomponio/neuroHarmonize
project_urls =
Bug Tracker = https://github.com/rpomponio/neuroHarmonize/issues
classifiers =
Programming Language :: Python :: 3
License :: OSI Approved :: MIT License
Operating System :: OS Independent

[options]
package_dir =
= src
packages = find:
python_requires = >=3.6

[options.packages.find]
where = src
17 changes: 10 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ features:
Installation
------------

Latest version: ``1.0.x`` (August 27, 2020)
Latest version: ``2.0.0`` (May 2021)

Requirements:

Expand All @@ -39,14 +39,17 @@ Requirements:
*To make installation easier, neuroCombat is not a formal dependency for this
package, but the source code is included to call neuroCombat functions.*

**Option 1: Install from PyPI (not available yet)**
**Option 1: Install from PyPI**

*Instructions will be written once package is released on PyPI. The package
cannot be released on PyPI until a developer version of statsmodels is released.*
To install the latest version of ``neuroHarmonize``, run the following in the command line:

>>> pip install neuroHarmonize

**Option 2: Install from GitHub**

1. Install the developer version of ``statsmodels``. This package depends on ``statsmodels v0.12.0.dev0``. Until the dev version is released on PyPI, the current workaround is to run the following in the command line:
*Use if the first option fails.*

1. Install the developer version of ``statsmodels``. This package depends on ``statsmodels v0.12.x``. Run the following in the command line:

>>> pip install git+https://github.com/statsmodels/statsmodels

Expand All @@ -57,8 +60,8 @@ cannot be released on PyPI until a developer version of statsmodels is released.
Quick Start
-----------

*Please note that the ComBat [3]_ algorithm corrects for site effects but
intentionally preserves covariate effects.* If you wish to remove covariate
*Please note:* the ComBat [3]_ algorithm corrects for site effects but
intentionally preserves covariate effects. If you wish to remove covariate
effects as well you can use the argument ``return_s_data``.

You must provide a **data matrix** which is a ``numpy.array`` containing the
Expand Down
6 changes: 6 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[build-system]
requires = [
"setuptools>=42",
"wheel"
]
build-backend = "setuptools.build_meta"
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ def readme():
return f.read()

setup(name='neuroHarmonize',
version='1.0.0',
version='2.0.0',
description='Harmonization tools for multi-center neuroimaging studies.',
long_description=readme(),
url='https://github.com/rpomponio/neuroHarmonize',
author='Raymond Pomponio',
author_email='[email protected]',
license='MIT',
packages=['neuroHarmonize'],
install_requires=['numpy', 'pandas', 'nibabel', 'statsmodels>=0.11.0.dev0'],
install_requires=['numpy', 'pandas', 'nibabel', 'statsmodels>=0.12.0'],
zip_safe=False)

0 comments on commit 50ff4b1

Please sign in to comment.