Skip to content
Browse files

tweaking setup etc. registering with pypi

  • Loading branch information...
1 parent e064137 commit d1200a395ab469809629a20ec3172a59cc8d1e01 @dfm committed
Showing with 92 additions and 14 deletions.
  1. +20 −0 LICENSE.markdown
  2. +15 −5 README.md → README.markdown
  3. +57 −9 setup.py
View
20 LICENSE.markdown
@@ -0,0 +1,20 @@
+Copyright (c) 2012 Steve Losh and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+**THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.**
+
+
View
20 README.md → README.markdown
@@ -1,4 +1,5 @@
-#ACOR
+ACOR
+====
This is a direct port of a C++ routine by
[Jonathan Goodman](http://www.math.nyu.edu/faculty/goodman/index.html) (NYU) called
@@ -9,9 +10,16 @@ estimates the autocorrelation time of time series data very quickly.
interface in order to write a Python wrapper (with the permission of the original
author).
-##Installation
+Installation
+------------
-To obtain the software, download the source code and documentation [as a
+Just run
+
+ pip install acor
+
+with `sudo` if you need it.
+
+Otherwise, download the source code [as a
tarball](https://github.com/dfm/acor/tarball/master) or clone the git
repository from [GitHub](https://github.com/dfm/acor):
@@ -26,7 +34,8 @@ to compile and install the module `acor` in your Python path. The only dependenc
is [NumPy](http://numpy.scipy.org/) (including the `python-dev` and `python-numpy-dev`
packages which you might have to install separately on some systems).
-##Usage
+Usage
+-----
Given some time series `x`, you can estimate the autocorrelation time (`tau`) using:
@@ -35,7 +44,8 @@ import acor
tau, mean, sigma = acor.acor(x)
```
-##References
+References
+----------
* http://www.math.nyu.edu/faculty/goodman/software/acor/index.html
* http://www.stat.unc.edu/faculty/cji/Sokal.pdf
View
66 setup.py
@@ -5,14 +5,62 @@
from distutils.extension import Extension
import numpy.distutils.misc_util
-setup(name='acor',
- version='1',
- description='Estimate your autocorrelation times very quickly.',
- author='Daniel Foreman-Mackey',
- author_email='danfm@nyu.edu',
- packages=['acor'],
- ext_modules = [Extension('acor._acor', ['acor/_acor.c', 'acor/acor.c'])],
- include_dirs = numpy.distutils.misc_util.get_numpy_include_dirs()
- )
+long_description = """
+ACOR
+====
+This is a direct port of a C++ routine by
+`Jonathan Goodman <http://www.math.nyu.edu/faculty/goodman/index.html>`_
+(NYU) called
+`ACOR <http://www.math.nyu.edu/faculty/goodman/software/acor/index.html>`_
+that estimates the autocorrelation time of time series data very quickly.
+
+`Dan Foreman-Mackey <http://danfm.ca>`_ (NYU) made a few surface changes to the
+interface in order to write a Python wrapper (with the permission of the original
+author).
+
+Installation
+------------
+
+Just run ``pip install acor`` with the optional ``sudo`` if you need it. NumPy
+and the associated ``dev`` headers are needed.
+
+Usage
+-----
+
+Given some time series ``x``, you can estimate the autocorrelation time
+(``tau``) using::
+
+import acor
+tau, mean, sigma = acor.acor(x)
+
+References
+----------
+
+* http://www.math.nyu.edu/faculty/goodman/software/acor/index.html
+* http://www.stat.unc.edu/faculty/cji/Sokal.pdf
+
+"""
+
+setup(
+ name="acor",
+ version="1.0.0",
+ author="Daniel Foreman-Mackey and Jonathan Goodman",
+ author_email="danfm@nyu.edu",
+ packages=["acor"],
+ url="http://github.com/dfm/acor/",
+ license="MIT",
+ description="Estimate the autocorrelation time of a time series very quickly.",
+ long_description=long_description,
+ install_requires=["numpy"],
+ ext_modules = [Extension('acor._acor', ['acor/_acor.c', 'acor/acor.c'])],
+ include_dirs = numpy.distutils.misc_util.get_numpy_include_dirs(),
+ classifiers=[
+ "Development Status :: 3 - Alpha",
+ "Intended Audience :: Science/Research",
+ "License :: OSI Approved :: MIT License",
+ "Operating System :: OS Independent",
+ "Programming Language :: Python",
+ ],
+)

0 comments on commit d1200a3

Please sign in to comment.
Something went wrong with that request. Please try again.