Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 136 lines (91 sloc) 4.073 kb
e1a048d @jarrodmillman updating README
jarrodmillman authored
1 =================================================
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
2 Developing SciPy
e1a048d @jarrodmillman updating README
jarrodmillman authored
3 =================================================
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
4
c0e1d0a @pearu Impl. ScipyTest class that will facilitate testing dropped-into-Lib Scip...
pearu authored
5 .. Contents::
6
e1a048d @jarrodmillman updating README
jarrodmillman authored
7
a173f85 @jarrodmillman updating documentation
jarrodmillman authored
8 What is SciPy?
e1a048d @jarrodmillman updating README
jarrodmillman authored
9 --------------
10
11 SciPy (pronounced "Sigh Pie") is open-source software for mathematics,
12 science, and engineering. It includes modules for statistics, optimization,
13 integration, linear algebra, Fourier transforms, signal and image processing,
a173f85 @jarrodmillman updating documentation
jarrodmillman authored
14 ODE solvers, and more. It is also the name of a very popular conference on
15 scientific programming with Python.
e1a048d @jarrodmillman updating README
jarrodmillman authored
16
17 The SciPy library depends on NumPy, which provides convenient and fast
18 N-dimensional array manipulation. The SciPy library is built to work with
19 NumPy arrays, and provides many user-friendly and efficient numerical routines
20 such as routines for numerical integration and optimization. Together, they
21 run on all popular operating systems, are quick to install, and are free of
22 charge. NumPy and SciPy are easy to use, but powerful enough to be depended
23 upon by some of the world's leading scientists and engineers. If you need to
24 manipulate numbers on a computer and display or publish the results, give
25 SciPy a try!
26
27
28 SciPy structure
29 ---------------
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
30
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
31 SciPy aims at being a robust and efficient "super-package" of a number
32 of modules, each of a non-trivial size and complexity. In order for
33 "SciPy integration" to work flawlessly, all SciPy modules must follow
34 certain rules that are described in this document. Hopefully this
35 document will be helpful for SciPy contributors and developers as a
36 basic reference about the structure of the SciPy package.
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
37
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
38 Currently SciPy consists of the following files and directories:
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
39
40 INSTALL.txt
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
41 SciPy prerequisites, installation, testing, and troubleshooting.
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
42
43 THANKS.txt
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
44 SciPy developers and contributors. Please keep it up to date!!
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
45
14aed92 @stefanv Corrected a reference to an outdated filename in the documentation
stefanv authored
46 README.txt
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
47 SciPy structure (this document).
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
48
49 setup.py
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
50 Script for building and installing SciPy.
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
51
52 MANIFEST.in
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
53 Additions to distutils-generated SciPy tar-balls. Its usage is
54 deprecated.
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
55
e13a816 @jarrodmillman few fixes leftover from switch to scipy/ from Lib/
jarrodmillman authored
56 scipy/
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
57 Contains SciPy __init__.py and the directories of SciPy modules.
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
58
0c067eb More fixes to docs
edschofield authored
59 SciPy modules
e1a048d @jarrodmillman updating README
jarrodmillman authored
60 +++++++++++++
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
61
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
62 In the following, a *SciPy module* is defined as a Python package, say
e13a816 @jarrodmillman few fixes leftover from switch to scipy/ from Lib/
jarrodmillman authored
63 xxx, that is located in the scipy/ directory. All SciPy modules should
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
64 follow the following conventions:
65
eb18268 Documentation and version updates since 0.4.8 release
edschofield authored
66 * Ideally, each SciPy module should be as self-contained as possible.
67 That is, it should have minimal dependencies on other packages or
68 modules. Even dependencies on other SciPy modules should be kept to a
69 minimum. A dependency on NumPy is of course assumed.
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
70
c0e1d0a @pearu Impl. ScipyTest class that will facilitate testing dropped-into-Lib Scip...
pearu authored
71 * Directory ``xxx/`` must contain
72
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
73 + a file ``setup.py`` that defines
a870025 @pearu Quick updates to *.txt files.
pearu authored
74 ``configuration(parent_package='',top_path=None)`` function.
7434b18 @pearu Cleanup and doc updates
pearu authored
75 See below for more details.
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
76
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
77 + a file ``info.py``. See below more details.
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
78
c0e1d0a @pearu Impl. ScipyTest class that will facilitate testing dropped-into-Lib Scip...
pearu authored
79 * Directory ``xxx/`` may contain
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
80
c0e1d0a @pearu Impl. ScipyTest class that will facilitate testing dropped-into-Lib Scip...
pearu authored
81 + a directory ``tests/`` that contains files ``test_<name>.py``
9073df1 @pearu Incr. micro version number. New style importing hooks will follow soon (...
pearu authored
82 corresponding to modules ``xxx/<name>{.py,.so,/}``. See below for
c0e1d0a @pearu Impl. ScipyTest class that will facilitate testing dropped-into-Lib Scip...
pearu authored
83 more details.
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
84
48e618d @pearu Doc updates. Hey, scipy is bdist_rpm-able\!
pearu authored
85 + a file ``MANIFEST.in`` that may contain only ``include setup.py`` line.
86 DO NOT specify sources in MANIFEST.in, you must specify all sources
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
87 in setup.py file. Otherwise released SciPy tarballs will miss these sources.
c0e1d0a @pearu Impl. ScipyTest class that will facilitate testing dropped-into-Lib Scip...
pearu authored
88
aea889b Documentation updates folded back from 0.4.4 branch
edschofield authored
89 + a directory ``docs/`` for documentation.
01bda66 @pearu Introducing DEVELOPERS.txt and making .txt files ReST compatible
pearu authored
90
a870025 @pearu Quick updates to *.txt files.
pearu authored
91 For details, read:
9073df1 @pearu Incr. micro version number. New style importing hooks will follow soon (...
pearu authored
92
6c01760 @stefanv Update Trac URLs.
stefanv authored
93 http://projects.scipy.org/numpy/wiki/DistutilsDoc
9d25a33 @pearu Doc updates (get_path,SourceFilter). Added discussion section about docu...
pearu authored
94
95
96 Documentation
e1a048d @jarrodmillman updating README
jarrodmillman authored
97 -------------
9d25a33 @pearu Doc updates (get_path,SourceFilter). Added discussion section about docu...
pearu authored
98
a173f85 @jarrodmillman updating documentation
jarrodmillman authored
99 The documentation site is here
100 http://docs.scipy.org
9d25a33 @pearu Doc updates (get_path,SourceFilter). Added discussion section about docu...
pearu authored
101
e1a048d @jarrodmillman updating README
jarrodmillman authored
102 Web sites
103 ---------
104
105 The user's site is here
106 http://www.scipy.org/
107
108 The developer's site is here
6c01760 @stefanv Update Trac URLs.
stefanv authored
109 http://projects.scipy.org/scipy/wiki
e1a048d @jarrodmillman updating README
jarrodmillman authored
110
111
112 Mailing Lists
113 -------------
114
115 Please see the developer's list here
9b9a017 @jarrodmillman udpating documentation
jarrodmillman authored
116 http://projects.scipy.org/mailman/listinfo/scipy-dev
e1a048d @jarrodmillman updating README
jarrodmillman authored
117
118
119 Bug reports
120 -----------
121
122 To search for bugs, please use the NIPY Bug Tracker at
6c01760 @stefanv Update Trac URLs.
stefanv authored
123 http://projects.scipy.org/scipy/query
e1a048d @jarrodmillman updating README
jarrodmillman authored
124
125 To report a bug, please use the NIPY Bug Tracker at
6c01760 @stefanv Update Trac URLs.
stefanv authored
126 http://projects.scipy.org/scipy/newticket
e1a048d @jarrodmillman updating README
jarrodmillman authored
127
128
129 License information
130 -------------------
9d25a33 @pearu Doc updates (get_path,SourceFilter). Added discussion section about docu...
pearu authored
131
e1a048d @jarrodmillman updating README
jarrodmillman authored
132 See the file "LICENSE" for information on the history of this
133 software, terms & conditions for usage, and a DISCLAIMER OF ALL
134 WARRANTIES.
9b9a017 @jarrodmillman udpating documentation
jarrodmillman authored
135
Something went wrong with that request. Please try again.