Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
K
kwant
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Michael Wimmer
kwant
Commits
9f3fbbf3
Commit
9f3fbbf3
authored
12 years ago
by
Christoph Groth
Browse files
Options
Downloads
Patches
Plain Diff
update README.txt
parent
07fd47d4
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.txt
+14
-10
14 additions, 10 deletions
README.txt
with
14 additions
and
10 deletions
README.txt
+
14
−
10
View file @
9f3fbbf3
...
...
@@ -19,9 +19,9 @@ The prerequisites are
- More or less current versions of `Python <http://python.org>`_ and `SciPy
<http://scipy.org>`_. Python 2.6 and scipy 0.7.2 should be enough.
- An environment which allows to compile Python extensions written in C
. This
includes a C compiler and Python C headers. The latter might
be provided in
a separate package like ``python-dev``.
- An environment which allows to compile Python extensions written in C
and
C++. This
includes a C
/C++
compiler and Python C headers. The latter might
be provided in
a separate package like ``python-dev``.
- Some incarnation of `LAPACK <http://www.netlib.org/lapack/>`_.
...
...
@@ -95,17 +95,21 @@ somewhere in the Python search path to the the package subdirectory.
Some conventions to keep in mind:
* Please keep the code consistent by adhering to the already used naming and
formatting conventions. We generally follow the `"Style Guide for Python
Code" <http://www.python.org/dev/peps/pep-0008/>`_ and the `"Docstring
Conventions" <http://www.python.org/dev/peps/pep-0257/>`_.
* Write tests for all the important functionality you add. Be sure not to
break existing tests.
* Please keep the code consistent by adhering to the prevailing naming and
formatting conventions. We generally follow the `"Style Guide for Python
Code" <http://www.python.org/dev/peps/pep-0008/>`_ For docstrings, we follow
`NumPy's "Docstring Standard"
<http://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_ and
`Python's "Docstring Conventions"
<http://www.python.org/dev/peps/pep-0257/>`_.
Several modules are written in `Cython <http://cython.org/>`_ (.pyx file name
extension). You will need Cython (>= 0.15) if you want to modify them. Turn
on cythonization by passing the option ``--run-cython`` to setup.py.
extension). You will need Cython 0.18 if you want to modify them. (If Cython
0.18 is not released yet, try the bleeding-edge version.) Turn on
cythonization by passing the option ``--run-cython`` to setup.py.
Tests
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment