Skip to content

Commit be6a8be

Browse files
updating rendered version
1 parent aa3a6ec commit be6a8be

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+3244
-1268
lines changed

.DS_Store

6 KB
Binary file not shown.

.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 5b5485dcfe406fd9f766a87b48ce0ea8
3+
config: cbd7e031f47c4eeff9f0ceaf8bd09f7a
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

_downloads/agc_example.zip

5.87 KB
Binary file not shown.

_sources/index.rst.txt

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,18 @@
11
In This Collection
22
==================
33

4-
.. ifslides::
4+
Topics:
5+
-------
56

6-
+-------------------------------+
7-
| Topics: |
8-
+===============================+
9-
| .. toctree:: |
10-
| :maxdepth: 1 |
11-
| |
12-
| weak_references |
13-
| persistance_serialization |
14-
+-------------------------------+
7+
.. toctree::
8+
:maxdepth: 1
159

16-
.. ifnotslides::
10+
weak_references
11+
persistance_serialization
12+
where_to_put_tests
13+
where_to_put_your_code
14+
interfacing_with_c/index
1715

18-
Topics:
19-
-------
20-
21-
.. toctree::
22-
:maxdepth: 1
23-
24-
weak_references
25-
persistance_serialization
26-
where_to_put_tests
27-
where_to_put_your_code
28-
29-
.. rst-class:: credit
3016

3117
These materials copyright Christopher H. Barker
3218

_sources/interfacing_with_c/c_python.rst.txt

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ Documentation:
1212
Core docs for the C API:
1313

1414

15+
https://docs.python.org/3/extending/
1516

1617

1718
Interfacing methods:
1819
====================
1920

2021
There a bunch of ways to interface C and Python:
2122

23+
2224
Hand write against the C API:
2325
-----------------------------
2426

@@ -35,14 +37,14 @@ Cython can be described as a "python-like language for writing python extensions
3537

3638
It can be used essentially to speed up Python, but also to call Python from C.
3739

38-
(derived from Pyrex)
40+
https://cython.org/
3941

40-
XDress
41-
......
4242

4343
ctypes
4444
------
4545

46+
Ctypes comes with PYthon out of the box.
47+
4648

4749
SWIG, SIP, ETC.
4850
---------------
@@ -53,5 +55,9 @@ Auto wrapper generators.
5355
EXAMPLE:
5456
========
5557

56-
Same as the one for fortran: a automatic gain control filter.
58+
Same as the one for fortran: a automatic gain control filter:
59+
60+
:download:`agc_example.zip`
61+
62+
5763

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Interfacing with C / Fortran
2+
============================
3+
4+
**Warning** These notes are a bit out of date, and have not been tested or updated in a few years. But hopefully there is still some useful stuff in here.
5+
6+
7+
Topics:
8+
-------
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
13+
c_python
14+
fortran_python
15+
16+
There is a farily complete (but poorly documented) example of multiple approaches using and Automatic Gain Control filter here:
17+
18+
:download:`agc_example.zip`
19+
20+
21+
These materials copyright Christopher H. Barker
22+
23+
Licensed under the Creative Commons Attribution-ShareAlike 4.0 International Public License.
24+
25+
https://creativecommons.org/licenses/by-sa/4.0/legalcode
26+
27+
28+

_sources/where_to_put_tests.rst.txt

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Test system recommendations
1818

1919
https://pytest.org/latest/goodpractises.html
2020

21-
I need to add links for ``nose`` and ``unittest``.... PR's accepted!
21+
I need to add links for ``nose`` and ``unittest`` ... PR's accepted!
2222

2323

2424
Two Options
2525
-----------
2626

27-
In Python packaging, there seems is no consensus on where you should put your test suite. This thread:
27+
In Python packaging, there is no consensus on where you should put your test suite. This thread:
2828

2929
https://mail.python.org/pipermail/distutils-sig/2015-October/027003.html
3030

@@ -50,7 +50,10 @@ https://packaging.python.org/en/latest/
5050

5151
for recommendations.
5252

53-
2) The other options is to put your test code in a sub-package inside your package. In this case, it should be inside your package, and *be* a package itself (i.e. have an ``__init__.py``)::
53+
In the this case, the directory with all the tests shouls not be a python package -- this is, it should not have a ``__init__.py`` file.
54+
55+
56+
2) The other options is to put your test code in a sub-package inside your package. In this case, it should be inside your package, and *be* a python package itself (i.e. have an ``__init__.py``)::
5457

5558
my_package
5659
__init__.py
@@ -61,7 +64,7 @@ for recommendations.
6164
test_1.py
6265
test_2.py
6366

64-
Self contained
67+
Self Contained
6568
--------------
6669

6770
The advantage of keeping test code self-contained is that you can have a large suite of tests with sample data and who knows what, and it won't bloat and complicate the installed package (and test code can write to the test dirs, etc. Also, you can then run the test suite against an installed version that may not be exactly the same as the current live code.

_static/css/badge_only.css

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)