|
1 |
| -.. -*- rst -*- rest mode for emacs |
2 |
| -
|
3 |
| -======================== |
4 |
| - Development quickstart |
5 |
| -======================== |
6 |
| - |
7 |
| -Source Code |
8 |
| -=========== |
9 |
| - |
10 |
| -NIPY uses launchpad_ for our code hosting. For immediate access to |
11 |
| -the source code, see the `nipy launchpad`_ site. |
12 |
| - |
13 |
| -Guidelines |
14 |
| -========== |
15 |
| - |
16 |
| -We have adopted many developer guidelines in an effort to make |
17 |
| -development easy, and the source code readable, consistent and robust. |
18 |
| -Many of our guidelines are adopted from the scipy_ / numpy_ community. |
19 |
| -We welcome new developers to the effort, if you're interested in |
20 |
| -developing code or documentation please join the `nipy mailing list`_ |
21 |
| -and introduce yourself. If you plan to do any code development, we |
22 |
| -ask that you take a look at the following guidelines. We do our best |
23 |
| -to follow these guidelines ourselves: |
24 |
| - |
25 |
| -* :ref:`howto_document` : Documentation is critical. This document |
26 |
| - describes the documentation style, syntax, and tools we use. |
27 |
| - |
28 |
| -* `Numpy/Scipy Coding Style Guidelines: |
29 |
| - <http://projects.scipy.org/scipy/numpy/wiki/CodingStyleGuidelines>`_ |
30 |
| - This is the coding style we strive to maintain. |
31 |
| - |
32 |
| -* :ref:`bzr_workflow` : This describes our process for version control. |
33 |
| - |
34 |
| -* :ref:`testing` : We've adopted a rigorous testing framework. |
35 |
| - |
36 |
| -* :ref:`optimization`: "premature optimization is the root of all |
37 |
| - evil." |
38 |
| - |
39 |
| -.. _trunk_download: |
40 |
| - |
41 |
| -Checking out the latest version |
42 |
| -=============================== |
43 |
| - |
44 |
| -To check out the latest version of nipy you need bzr version greater than |
45 |
| -0.92:: |
46 |
| - |
47 |
| - bzr branch lp:nipy |
48 |
| - |
49 |
| -There are two methods to install a development version of nipy. For |
50 |
| -both methods, build the extensions in place:: |
51 |
| - |
52 |
| - python setup.py build_ext --inplace |
53 |
| - |
54 |
| -Then you can either: |
55 |
| - |
56 |
| -#. Use the ``mynipy`` script in the tools directory of the nipy |
57 |
| - source. There are directions and examples in the docstring of that |
58 |
| - file, but basically it updates a symbolic link in your |
59 |
| - *site-packages* directory to the inplace build of your source. The |
60 |
| - advantage of this method is it does not require any modifications of |
61 |
| - your PYTHONPATH. |
62 |
| - |
63 |
| -#. Place the source directory in your PYTHONPATH. |
64 |
| - |
65 |
| -With either method, all of the modifications made to your source tree |
66 |
| -will be picked up when nipy is imported. |
67 |
| - |
68 |
| - |
69 |
| -Submitting a patch |
70 |
| -================== |
71 |
| - |
72 |
| -The preferred method to submit a patch is to create a branch of nipy on |
73 |
| -your machine, modify the code and push that branch to your launchpad |
74 |
| -directory. Then email the list and we will review your code and |
75 |
| -hopefully apply (merge) your patch. See the instructions for |
76 |
| -:ref:`init_trunk_dev`. |
77 |
| - |
78 |
| -If you do not wish to use bazaar and launchpad, please feel free to |
79 |
| -file a bug report and submit a patch or email the `nipy mailing |
80 |
| -list`_. |
81 |
| - |
82 |
| -Bug reports |
83 |
| -=========== |
84 |
| - |
85 |
| -If you find a bug in nipy, please submit a bug report at the `nipy |
86 |
| -bugs`_ launchpad site so that we can fix it. |
87 |
| - |
88 |
| - |
89 |
| -.. include:: doc/links_names.txt |
| 1 | +For installation instructions see documentation |
0 commit comments