forked from statsmodels/statsmodels
/
README.txt
132 lines (88 loc) · 4.13 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
What it is
==========
Statsmodels is a Python package that provides a complement to scipy for
statistical computations including descriptive statistics and
estimation of statistical models.
Main Features
=============
* regression: Generalized least squares (including weighted least squares and
least squares with autoregressive errors), ordinary least squares.
* glm: Generalized linear models with support for all of the one-parameter
exponential family distributions.
* discrete: regression with discrete dependent variables, including Logit, Probit,
MNLogit, Poisson, based on maximum likelihood estimators
* rlm: Robust linear models with support for several M-estimators.
* tsa: models for time series analysis
- univariate time series analysis: AR, ARIMA
- vector autoregressive models, VAR and structural VAR
- descriptive statistics and process models for time series analysis
* nonparametric : (Univariate) kernel density estimators
* datasets: Datasets to be distributed and used for examples and in testing.
* stats: a wide range of statistical tests
- diagnostics and specification tests
- goodness-of-fit and normality tests
- functions for multiple testing
- various additional statistical tests
* iolib: Tools for reading Stata .dta files into numpy arrays. (not yet ported to Python 3)
* iolob: printing table output to ascii, latex, and html
* miscellaneous models
* sandbox: statsmodels contains a sandbox folder with code in various stages of
developement and testing which is not considered "production ready".
This covers among others Mixed (repeated measures) Models, GARCH models, general method
of moments (GMM) estimators, kernel regression, various extensions to scipy.stats.distributions,
panel data models, generalized additive models and information theoretic measures.
Where to get it
===============
Development branches will be on Github. This is where to go to get the most
up to date code in the trunk branch. Experimental code is hosted here
in branches and in developer forks. This code is merged to master often. We
try to make sure that the master branch is always stable.
https://www.github.com/statsmodels/statsmodels
Source download of stable tags will be on SourceForge.
https://sourceforge.net/projects/statsmodels/
or
PyPi: http://pypi.python.org/pypi/statsmodels/
Installation from sources
=========================
In the top directory, just do::
python setup.py install
See INSTALL.txt for requirements or
http://statsmodels.sourceforge.net/
For more information.
License
=======
Simplified BSD
Documentation
=============
The official documentation is hosted on SourceForge.
http://statsmodels.sourceforge.net/
The sphinx docs are currently undergoing a lot of work. They are not yet
comprehensive, but should get you started.
Our blog will continue to be updated as we make progress on the code.
http://scipystats.blogspot.com
Windows Help
============
The source distribution for Windows includes a htmlhelp file (statsmodels.chm).
This can be opened from the python interpreter ::
>>> import statsmodels.api as sm
>>> sm.open_help()
Discussion and Development
==========================
All chatter will take place on the or scipy-user mailing list. We are very
interested in receiving feedback about usability, suggestions for improvements,
and bug reports via the mailing list or the bug tracker at
https://github.com/statsmodels/statsmodels/issues
There is also a google group at
http://groups.google.com/group/pystatsmodels
to discuss development and design issues that are deemed to be too specialized
for the scipy-dev/user list.
Python 3
========
statsmodels has been ported and tested for Python 3.2. Python 3
version of the code can be obtained by running 2to3.py over the entire
statsmodels source. The numerical core of statsmodels worked almost without
changes, however there can be problems with data input and plotting.
The STATA file reader and writer in iolib.foreign has not been ported yet.
And there are still some problems with the matplotlib version for Python 3
that was used in testing. Running the test suite with Python 3.2 shows some
errors related to foreign and matplotlib.