Skip to content
Browse files

DOC: Update INSTALL

  • Loading branch information...
1 parent cd48c3b commit fb35727a97b3c8f065632b260e1d9267d0866d50 @jseabold jseabold committed Apr 1, 2012
Showing with 60 additions and 27 deletions.
  1. +60 −27 INSTALL.txt
View
87 INSTALL.txt
@@ -1,75 +1,108 @@
Dependencies
------------
-Python >= 2.5
-NumPy >= 1.4.0
-SciPy >= 0.7
+python >= 2.5
+
+ www.python.org
+
+numpy >= 1.4.0
+
+ www.numpy.org
+
+scipy >= 0.7
+
+ www.scipy.org
+
+pandas >= 0.7.1
+
+ pydata.pandas.org
+
Optional Dependencies
---------------------
-Matplotlib is needed for plotting functionality and running many of the examples
+cython >= 0.15.1
+
+ http://cython.org/
-http://matplotlib.sourceforge.net/
+ If Cython is available during installation from source faster functions
+ will be installed in some places provided you have a C compiler. It is
+ recommended to install from source with Cython available, as this will not
+ be optional in the 0.5 release.
-To build the documentation you will need Sphinx
+matplotlib >= 1.0.0
-http://sphinx.pocoo.org/
+ http://matplotlib.sf.net/
-The documentation is available online as mentioned below.
+ Matplotlib is needed for plotting functionality and running many of the
+ examples.
-To run the test suite you will need nose
+sphinx >= 1.0.0
-http://somethingaboutorange.com/mrl/projects/nose/
+ http://sphinx.pocoo.org/
+
+ Sphinx is used to build the documentation.
+
+nose >= 1.0.0
+
+ http://readthedocs.org/docs/nose/en/latest/
+
+ Nose is needed to run the tests.
Easy Install
------------
-To get the latest release using easy_install you need setuptools (easy_install)
+To get the latest release using easy_install you need setuptools (easy_install):
-http://peak.telecommunity.com/DevCenter/EasyInstall
+ http://peak.telecommunity.com/DevCenter/EasyInstall
-Then you can do (with proper permissions)
+Then you can do (with proper permissions):
+
+ easy_install -U statsmodels
-easy_install -U statsmodels
Ubuntu/Debian
-------------
-On (X)ubuntu you can get dependencies through
+On Ubuntu you can get dependencies through:
+
+ sudo apt-get install python python-dev python-setuptools python-numpy python-scipy
+ easy_install -U pandas
+ easy_install -U cython
-sudo apt-get install python python-setuptools python-numpy python-scipy
+Alternatively, you can install from the NeuroDebian repository:
+
+ http://neuro.debian.net
-You may install with easy_install, from source as mentioned below, or
-from the NeuroDebian repository: http://neuro.debian.net
Installing from Source
----------------------
Download and extract the source distribution from PyPI or github
-PyPI: http://pypi.python.org/pypi/statsmodels
-Github: https://github.com/statsmodels/statsmodels/archives/master
+ http://pypi.python.org/pypi/statsmodels
+ https://github.com/statsmodels/statsmodels/tags
Or clone the bleeding edge code from our repository on github at
-https://github.com/statsmodels/statsmodels
+ git clone git://github.com/statsmodels/statsmodels.git
In the statsmodels directory do (with proper permissions)
-python setup.py install
+ python setup.py install
+
+
+Installing from Source on Windows
+---------------------------------
-For the 0.3.0 release, there is some code written using Cython. If you have
-a C compiler, you can do
+See http://statsmodels.sf.net/devel/install.html#windows.
-python setup.py --with-cython
-python setup.py install
Documentation
-------------
You may find more information about the project and installation in our
documentation
-http://statsmodels.sourceforge.net/
+http://statsmodels.sf.net/devel/install.html

0 comments on commit fb35727

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