Permalink
Browse files

update setup.py - write long_description in RST

  • Loading branch information...
TaiSakuma committed Jan 28, 2018
1 parent b0f8ca4 commit be9e3cf482717409173b71daa53a53b0853f7f89
Showing with 20 additions and 4 deletions.
  1. +20 −4 setup.py
@@ -1,11 +1,27 @@
from setuptools import setup, find_packages
import os
import versioneer
import pypandoc
here = os.path.abspath(os.path.dirname(__file__))
long_description = pypandoc.convert('README.md', 'rst')
long_description = """
*AlphaTwirl* is a python library that loops over event data and
summarizes them into multi-dimensional categorical data as data
frames. Event data, input to AlphaTwirl, are data with one entry (or
row) for one event: for example, data in `ROOT
<https://root.cern.ch/>`__ `TTrees
<https://root.cern.ch/doc/master/classTTree.html>`__ with one entry
per collision event of an `LHC
<https://home.cern/topics/large-hadron-collider>`__ experiment at
`CERN <http://home.cern/>`__. Event data are often large---too large
to be loaded in memory---because they have as many entries as events.
Multi-dimensional categorical data, the output of AlphaTwirl, have one
row for one category. They are usually small---small enough to be
loaded in memory---because they only have as many rows as categories.
Users can, for example, import them as data frames into `R
<https://www.r-project.org/>`__ and `pandas
<http://pandas.pydata.org/>`__, which usually load all data in memory,
and can perform categorical data analyses with a rich set of data
operations available in R and pandas.
"""
setup(
name='alphatwirl',

0 comments on commit be9e3cf

Please sign in to comment.