drvec 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (213) hide show
  1. drvec-0.1.0/CHANGELOG.md +216 -0
  2. drvec-0.1.0/COPYING +339 -0
  3. drvec-0.1.0/MANIFEST.in +34 -0
  4. drvec-0.1.0/PKG-INFO +205 -0
  5. drvec-0.1.0/README.md +171 -0
  6. drvec-0.1.0/csrc/VENDORED.json +27 -0
  7. drvec-0.1.0/csrc/build_drvec.py +208 -0
  8. drvec-0.1.0/csrc/engines/drvec/LICENSE +339 -0
  9. drvec-0.1.0/csrc/engines/drvec/Makefile +164 -0
  10. drvec-0.1.0/csrc/engines/drvec/include/diagmvhost.h +7 -0
  11. drvec-0.1.0/csrc/engines/drvec/include/fue_bridge.h +30 -0
  12. drvec-0.1.0/csrc/engines/drvec/include/fue_pre_reader.h +36 -0
  13. drvec-0.1.0/csrc/engines/drvec/include/main.h +315 -0
  14. drvec-0.1.0/csrc/engines/drvec/include/optimhost.h +6 -0
  15. drvec-0.1.0/csrc/engines/drvec/src/diagnose.c +1648 -0
  16. drvec-0.1.0/csrc/engines/drvec/src/drvec.c +11967 -0
  17. drvec-0.1.0/csrc/engines/drvec/src/drvmlest.c +183 -0
  18. drvec-0.1.0/csrc/engines/drvec/src/elfvarma.c +867 -0
  19. drvec-0.1.0/csrc/engines/drvec/src/fue_bridge.c +342 -0
  20. drvec-0.1.0/csrc/engines/drvec/src/fue_pre_reader.c +708 -0
  21. drvec-0.1.0/csrc/engines/drvec/src/nlatools.c +1104 -0
  22. drvec-0.1.0/csrc/engines/drvec/src/qnewtopt.c +462 -0
  23. drvec-0.1.0/csrc/lib/diagmv/diagmv.c +221 -0
  24. drvec-0.1.0/csrc/lib/diagmv/diagmv.h +39 -0
  25. drvec-0.1.0/csrc/lib/fuedet/fuedet.c +120 -0
  26. drvec-0.1.0/csrc/lib/fuedet/fuedet.h +65 -0
  27. drvec-0.1.0/csrc/lib/optim/lnsrch.c +145 -0
  28. drvec-0.1.0/docs/API.md +218 -0
  29. drvec-0.1.0/docs/PORT.md +415 -0
  30. drvec-0.1.0/pyproject.toml +101 -0
  31. drvec-0.1.0/setup.cfg +4 -0
  32. drvec-0.1.0/setup.py +84 -0
  33. drvec-0.1.0/src/drvec/__init__.py +22 -0
  34. drvec-0.1.0/src/drvec/_gsl.py +83 -0
  35. drvec-0.1.0/src/drvec/api.py +942 -0
  36. drvec-0.1.0/src/drvec/c_engine.py +391 -0
  37. drvec-0.1.0/src/drvec/cast.py +196 -0
  38. drvec-0.1.0/src/drvec/cli.py +592 -0
  39. drvec-0.1.0/src/drvec/data.py +295 -0
  40. drvec-0.1.0/src/drvec/diagnose.py +439 -0
  41. drvec-0.1.0/src/drvec/fdhess.py +130 -0
  42. drvec-0.1.0/src/drvec/fit.py +528 -0
  43. drvec-0.1.0/src/drvec/forecast.py +314 -0
  44. drvec-0.1.0/src/drvec/irfboot.py +216 -0
  45. drvec-0.1.0/src/drvec/levels.py +158 -0
  46. drvec-0.1.0/src/drvec/loglik.py +45 -0
  47. drvec-0.1.0/src/drvec/nla.py +266 -0
  48. drvec-0.1.0/src/drvec/parallel.py +86 -0
  49. drvec-0.1.0/src/drvec/params.py +311 -0
  50. drvec-0.1.0/src/drvec/rank.py +401 -0
  51. drvec-0.1.0/src/drvec/report.py +1712 -0
  52. drvec-0.1.0/src/drvec/results.py +167 -0
  53. drvec-0.1.0/src/drvec/rng.py +51 -0
  54. drvec-0.1.0/src/drvec/rungtable.py +82 -0
  55. drvec-0.1.0/src/drvec/start.py +317 -0
  56. drvec-0.1.0/src/drvec/stderr.py +33 -0
  57. drvec-0.1.0/src/drvec/xlink.py +226 -0
  58. drvec-0.1.0/src/drvec.egg-info/PKG-INFO +205 -0
  59. drvec-0.1.0/src/drvec.egg-info/SOURCES.txt +211 -0
  60. drvec-0.1.0/src/drvec.egg-info/dependency_links.txt +1 -0
  61. drvec-0.1.0/src/drvec.egg-info/entry_points.txt +2 -0
  62. drvec-0.1.0/src/drvec.egg-info/requires.txt +7 -0
  63. drvec-0.1.0/src/drvec.egg-info/top_level.txt +1 -0
  64. drvec-0.1.0/tests/accessors.py +166 -0
  65. drvec-0.1.0/tests/conftest.py +119 -0
  66. drvec-0.1.0/tests/data/fixtures/SOURCE +53 -0
  67. drvec-0.1.0/tests/data/fixtures/e1-inp/SOURCE +19 -0
  68. drvec-0.1.0/tests/data/fixtures/e1-inp/e1cons.inp +123 -0
  69. drvec-0.1.0/tests/data/fixtures/e1-inp/e1income.inp +123 -0
  70. drvec-0.1.0/tests/data/fixtures/e1-inp/e1invest.inp +123 -0
  71. drvec-0.1.0/tests/data/fixtures/e1alpha.txt +5 -0
  72. drvec-0.1.0/tests/data/fixtures/e1cons.pre +124 -0
  73. drvec-0.1.0/tests/data/fixtures/e1income.pre +124 -0
  74. drvec-0.1.0/tests/data/fixtures/e1invest.pre +124 -0
  75. drvec-0.1.0/tests/data/fixtures/e1seas.cons.pre +135 -0
  76. drvec-0.1.0/tests/data/fixtures/e1seas.income.pre +137 -0
  77. drvec-0.1.0/tests/data/fixtures/e1seas.invest.pre +142 -0
  78. drvec-0.1.0/tests/data/fixtures/make_m5.py +134 -0
  79. drvec-0.1.0/tests/data/fixtures/minkmu.pre +93 -0
  80. drvec-0.1.0/tests/data/fixtures/mmb40.mink.pre +103 -0
  81. drvec-0.1.0/tests/data/fixtures/mmdet.mink.pre +112 -0
  82. drvec-0.1.0/tests/data/fixtures/mmdet.minkmu.pre +112 -0
  83. drvec-0.1.0/tests/data/fixtures/mmdet.muskrat.pre +116 -0
  84. drvec-0.1.0/tests/data/fixtures/mmmon.mink.pre +104 -0
  85. drvec-0.1.0/tests/data/fixtures/mmmon.muskrat.pre +112 -0
  86. drvec-0.1.0/tests/data/fixtures/mmpre.mink.pre +93 -0
  87. drvec-0.1.0/tests/data/fixtures/mmpre.muskrat.pre +93 -0
  88. drvec-0.1.0/tests/data/fixtures/mmpre.step.pre +101 -0
  89. drvec-0.1.0/tests/data/fixtures/xmon.pre +110 -0
  90. drvec-0.1.0/tests/data/fixtures/xnet1.txt +1 -0
  91. drvec-0.1.0/tests/data/fixtures/xnet2.txt +1 -0
  92. drvec-0.1.0/tests/data/fixtures/xnetm.txt +1 -0
  93. drvec-0.1.0/tests/data/fixtures/xrev.pre +94 -0
  94. drvec-0.1.0/tests/data/fixtures/xrevar0.pre +100 -0
  95. drvec-0.1.0/tests/data/fixtures/xrevarma.pre +98 -0
  96. drvec-0.1.0/tests/data/fixtures/xrevdet.pre +112 -0
  97. drvec-0.1.0/tests/data/golden/README.md +30 -0
  98. drvec-0.1.0/tests/data/golden/est-dump.patch +14 -0
  99. drvec-0.1.0/tests/data/golden/proute.est.txt +48 -0
  100. drvec-0.1.0/tests/data/golden/rankboot.est.txt +462 -0
  101. drvec-0.1.0/tests/data/golden/rng_first.txt +13 -0
  102. drvec-0.1.0/tests/data/golden/rng_reference.c +25 -0
  103. drvec-0.1.0/tests/data/golden/specs.json +20 -0
  104. drvec-0.1.0/tests/data/oracle/SOURCE +211 -0
  105. drvec-0.1.0/tests/data/oracle/b40.forecast +27 -0
  106. drvec-0.1.0/tests/data/oracle/b40.out +797 -0
  107. drvec-0.1.0/tests/data/oracle/b40rank.out +120 -0
  108. drvec-0.1.0/tests/data/oracle/casepre.out +775 -0
  109. drvec-0.1.0/tests/data/oracle/cprank.out +120 -0
  110. drvec-0.1.0/tests/data/oracle/cprboot.boot +22 -0
  111. drvec-0.1.0/tests/data/oracle/cprboot.out +148 -0
  112. drvec-0.1.0/tests/data/oracle/cprq.out +122 -0
  113. drvec-0.1.0/tests/data/oracle/dboot.boot +12 -0
  114. drvec-0.1.0/tests/data/oracle/dboot.out +148 -0
  115. drvec-0.1.0/tests/data/oracle/dcpfc.forecast +21 -0
  116. drvec-0.1.0/tests/data/oracle/dcpfc.out +801 -0
  117. drvec-0.1.0/tests/data/oracle/dcprank.out +120 -0
  118. drvec-0.1.0/tests/data/oracle/dcpre.out +777 -0
  119. drvec-0.1.0/tests/data/oracle/ddet201.out +768 -0
  120. drvec-0.1.0/tests/data/oracle/ddet211.out +808 -0
  121. drvec-0.1.0/tests/data/oracle/dfc.forecast +27 -0
  122. drvec-0.1.0/tests/data/oracle/dfc.out +798 -0
  123. drvec-0.1.0/tests/data/oracle/dfcmon.forecast +35 -0
  124. drvec-0.1.0/tests/data/oracle/dfcmon.out +933 -0
  125. drvec-0.1.0/tests/data/oracle/dfdh.out +769 -0
  126. drvec-0.1.0/tests/data/oracle/dgate.out +684 -0
  127. drvec-0.1.0/tests/data/oracle/dgate2.out +673 -0
  128. drvec-0.1.0/tests/data/oracle/dgatepq.out +701 -0
  129. drvec-0.1.0/tests/data/oracle/dgateq.out +690 -0
  130. drvec-0.1.0/tests/data/oracle/drank.out +120 -0
  131. drvec-0.1.0/tests/data/oracle/dstep.out +806 -0
  132. drvec-0.1.0/tests/data/oracle/dxsys.out +763 -0
  133. drvec-0.1.0/tests/data/oracle/e1alpha.out +1247 -0
  134. drvec-0.1.0/tests/data/oracle/e1boot.boot +42 -0
  135. drvec-0.1.0/tests/data/oracle/e1boot.out +199 -0
  136. drvec-0.1.0/tests/data/oracle/e1cprank.out +170 -0
  137. drvec-0.1.0/tests/data/oracle/e1fc.forecast +38 -0
  138. drvec-0.1.0/tests/data/oracle/e1fc.out +1246 -0
  139. drvec-0.1.0/tests/data/oracle/e1fc.recursive +339 -0
  140. drvec-0.1.0/tests/data/oracle/e1fdh.out +1250 -0
  141. drvec-0.1.0/tests/data/oracle/e1fit.out +1291 -0
  142. drvec-0.1.0/tests/data/oracle/e1gate.out +1141 -0
  143. drvec-0.1.0/tests/data/oracle/e1ndrank.out +170 -0
  144. drvec-0.1.0/tests/data/oracle/e1rungs.out +52 -0
  145. drvec-0.1.0/tests/data/oracle/e1seas.out +1250 -0
  146. drvec-0.1.0/tests/data/oracle/e1sfc.forecast +38 -0
  147. drvec-0.1.0/tests/data/oracle/e1sfc.out +1244 -0
  148. drvec-0.1.0/tests/data/oracle/e1sfc.recursive +339 -0
  149. drvec-0.1.0/tests/data/oracle/e1srank.out +170 -0
  150. drvec-0.1.0/tests/data/oracle/ewin.forecast +19 -0
  151. drvec-0.1.0/tests/data/oracle/ewin.out +788 -0
  152. drvec-0.1.0/tests/data/oracle/ewin.recursive +67 -0
  153. drvec-0.1.0/tests/data/oracle/fc201.forecast +27 -0
  154. drvec-0.1.0/tests/data/oracle/fc201.out +796 -0
  155. drvec-0.1.0/tests/data/oracle/fc211.forecast +23 -0
  156. drvec-0.1.0/tests/data/oracle/fc211.out +831 -0
  157. drvec-0.1.0/tests/data/oracle/fcpre.forecast +21 -0
  158. drvec-0.1.0/tests/data/oracle/fcpre.out +799 -0
  159. drvec-0.1.0/tests/data/oracle/fdh201.out +767 -0
  160. drvec-0.1.0/tests/data/oracle/fdh211.out +806 -0
  161. drvec-0.1.0/tests/data/oracle/fixb2row.out +805 -0
  162. drvec-0.1.0/tests/data/oracle/fixb2s.out +763 -0
  163. drvec-0.1.0/tests/data/oracle/fixb2v.out +765 -0
  164. drvec-0.1.0/tests/data/oracle/gzero.out +774 -0
  165. drvec-0.1.0/tests/data/oracle/gzeroa.out +764 -0
  166. drvec-0.1.0/tests/data/oracle/irfboot.irfboot +170 -0
  167. drvec-0.1.0/tests/data/oracle/irfboot.out +846 -0
  168. drvec-0.1.0/tests/data/oracle/mon201.out +902 -0
  169. drvec-0.1.0/tests/data/oracle/ms201.out +772 -0
  170. drvec-0.1.0/tests/data/oracle/ms211.out +810 -0
  171. drvec-0.1.0/tests/data/oracle/msrank.out +124 -0
  172. drvec-0.1.0/tests/data/oracle/nodrift.out +775 -0
  173. drvec-0.1.0/tests/data/oracle/proute.out +806 -0
  174. drvec-0.1.0/tests/data/oracle/rankboot.boot +22 -0
  175. drvec-0.1.0/tests/data/oracle/rankboot.out +148 -0
  176. drvec-0.1.0/tests/data/oracle/rungs.out +44 -0
  177. drvec-0.1.0/tests/data/oracle/rungs3.out +44 -0
  178. drvec-0.1.0/tests/data/oracle/trend.out +779 -0
  179. drvec-0.1.0/tests/data/oracle/weakex1.out +771 -0
  180. drvec-0.1.0/tests/data/oracle/weakex2.out +774 -0
  181. drvec-0.1.0/tests/data/oracle/wxfix.out +766 -0
  182. drvec-0.1.0/tests/data/oracle/wxrow.out +1234 -0
  183. drvec-0.1.0/tests/data/oracle/xar0.out +795 -0
  184. drvec-0.1.0/tests/data/oracle/xarma.out +796 -0
  185. drvec-0.1.0/tests/data/oracle/xarma1.out +796 -0
  186. drvec-0.1.0/tests/data/oracle/xdet.out +794 -0
  187. drvec-0.1.0/tests/data/oracle/xlink.out +796 -0
  188. drvec-0.1.0/tests/data/oracle/xmon.out +929 -0
  189. drvec-0.1.0/tests/data/oracle/xsys.out +766 -0
  190. drvec-0.1.0/tests/oracle.py +76 -0
  191. drvec-0.1.0/tests/test_accessors.py +107 -0
  192. drvec-0.1.0/tests/test_bundled.py +123 -0
  193. drvec-0.1.0/tests/test_c_engine.py +310 -0
  194. drvec-0.1.0/tests/test_cli.py +129 -0
  195. drvec-0.1.0/tests/test_e1.py +124 -0
  196. drvec-0.1.0/tests/test_fdhess.py +92 -0
  197. drvec-0.1.0/tests/test_fit_case1.py +141 -0
  198. drvec-0.1.0/tests/test_forecast.py +116 -0
  199. drvec-0.1.0/tests/test_gate.py +87 -0
  200. drvec-0.1.0/tests/test_johansen.py +50 -0
  201. drvec-0.1.0/tests/test_levels.py +177 -0
  202. drvec-0.1.0/tests/test_loglik.py +42 -0
  203. drvec-0.1.0/tests/test_m5.py +401 -0
  204. drvec-0.1.0/tests/test_multistart.py +59 -0
  205. drvec-0.1.0/tests/test_options.py +200 -0
  206. drvec-0.1.0/tests/test_parallel.py +111 -0
  207. drvec-0.1.0/tests/test_rank.py +173 -0
  208. drvec-0.1.0/tests/test_rank_drift.py +185 -0
  209. drvec-0.1.0/tests/test_restrictions.py +102 -0
  210. drvec-0.1.0/tests/test_rng.py +20 -0
  211. drvec-0.1.0/tests/test_rungs.py +56 -0
  212. drvec-0.1.0/tests/test_trajectory.py +39 -0
  213. drvec-0.1.0/tests/test_vendored.py +99 -0
@@ -0,0 +1,216 @@
1
+ # Changelog
2
+
3
+ ## 0.1.0 — 2026-10-28
4
+
5
+ **The first release: the Python port of drvec C 0.13**, the VARMA-VEC of the
6
+ ATSW suite by exact maximum likelihood. `drvec.fit` (the VEC at a given rank:
7
+ alpha, beta, the short run, the restrictions on alpha, beta and Gamma with
8
+ their LR tests, forecasts and level responses), `drvec.rank_test` (the
9
+ sequential exact LR and its parametric bootstrap) and the `drvec-py` command,
10
+ which takes drvec C's arguments. On Linux x86_64 its files equal the C's byte
11
+ for byte on the oracle's commands; elsewhere to tolerance. The platform
12
+ wheels carry drvec C itself (`drvec/_bin`), on which the bootstraps run; the
13
+ pure wheel runs them in Python. The entries below are the port's development
14
+ diary, newest first.
15
+
16
+ - **`csrc/` from atsw-gui 800a540**, its main after PRs #93–#94: drvec C 0.13
17
+ with BUG-64 fixed, the I(1, r) check before the rank bootstrap and the
18
+ bootstrap block's text measured on Cavaliere, Rahbek and Taylor's (2012)
19
+ design. The port follows the three:
20
+ - **BUG-64** (`fit.make_admissible`): when no scaling of Lambda gives an
21
+ admissible start, the last resort is Lambda = 0.05 [I_r; 0], with F and
22
+ Theta shrunk as before. Ten oracles whose `cold` start found no admissible
23
+ point now fit it (dboot, dcpfc, ddet201, ddet211, dfdh, dcpre, drank,
24
+ dcprank, dfc, e1sfc): the search table changes, the optimum does not. In
25
+ xdet the `cold` start reaches a better optimum, logL -17.7259 against
26
+ -20.9312 (alpha error-correcting and significant), which `-multistart 30`
27
+ did not find before; xdet.out is the new fit.
28
+ - **The I(1, r) check** (`rank.i1r_check`, `rank.i1r_measure`): no sample
29
+ is drawn from a model under H0 that is not I(1, r) (an AR root on the
30
+ circle, or nabla Y2's long-run covariance singular); the `.out` says which
31
+ and the `.boot` has no line for it. The C engine's hook expects the same
32
+ comparisons to be skipped.
33
+ - **The bootstrap block** no longer quotes HOMOLOGATION's "six times /
34
+ four": rankboot, e1boot, cprboot and dboot carry the measured figures.
35
+ - **`csrc/` from atsw-gui abe6602**, its main after PRs #84–#86: drvec C 0.13
36
+ with BUG-61, BUG-62 and BUG-63 fixed and `-gzero`. BUG-63 flushes the rank
37
+ bootstrap's `.boot` line by line, so the C engine's progress
38
+ (`c_engine.Job.wait`) now moves at every replication instead of every ~4 KB.
39
+ `gzero.out` and `gzeroa.out` regenerated with it: each gains BUG-62's line,
40
+ and nothing else moves (tests/data/oracle/SOURCE).
41
+ - **The residual block names its columns** (atsw-gui BUG-62,
42
+ bugs/drvec-c-residual-labels). With r >= 1 the residuals drvec diagnoses
43
+ are those of (nabla Y2, W): the last r columns are the innovations of
44
+ beta'Y, not of the Y1 series, and the block printed them with no names. One
45
+ line before "residual sd" names them, in the port as in the C; `csrc/` is
46
+ vendored from atsw-gui e9304c6, and the 44 oracle `.out` files with r >= 1
47
+ carry the line (tests/data/oracle/SOURCE).
48
+ - **The CLI with -irfboot and too few replications for bands** ends as the C
49
+ does (`bugs/py-cli-irfboot-few`): exit 0, no `.irfboot` (the `.out` says
50
+ "Too few replications for bands"), and the `.forecast`/`.recursive` after
51
+ it written. It died writing None, left an empty `.irfboot` and skipped
52
+ them. The library was not affected.
53
+ - **`-gzero i j`, entries of Gamma(k) held at zero** (`drvec.fit(...,
54
+ gzero=[(i, j), ...])`, the CLI's `-gzero i j`): series j out of equation i's
55
+ short run, every lag; with `alpha`/`weakex` the conditional model's joint
56
+ restriction, its LR against the free VEC in the `.out` and in
57
+ `report.restriction_lr` (kind "gzero" or "gzero+alpha", `FitResult.gz_df`).
58
+ The port of drvec C's new option (atsw-gui 8626a2d, branch drvec-gamma-zero;
59
+ csrc/ re-vendored from it, only drvec.c moves); the
60
+ oracle's `gzero.out` and `gzeroa.out` are byte-identical, and in two series
61
+ `-gzero 1 2 -weakex 1` is `-xsys 1` (tests/test_options.py). For sima's
62
+ `test_restriction(gamma=...)`: the shakedown of sima 0.2.0, Martín Manjón
63
+ and Treadway (1997), the conditional model R0T | (R30, R3).
64
+
65
+ - `drvec.to_levels_varma(fit)` (PLAN-vec A4): the fitted VEC as a VARMA in
66
+ levels, forecast by drvarma's `forecast_given` (drvarma >= 0.3.0); it
67
+ agrees with drvec's own `-f` to 1e-12 relative on every golden `.forecast`
68
+ (docs/API.md). drvec's forecaster stays, under byte identity, and is now
69
+ one computation: `forecast_arrays` computes, `forecast_vec` prints the
70
+ `.out` section and the `.forecast` from its numbers.
71
+ - **drvec C inside the wheels** (PLAN-vec B5). The C sources of drvec 0.13
72
+ and the `lib/` pieces it links (optim, diagmv, fuedet) are vendored in
73
+ `csrc/`, byte for byte from atsw-gui 7ec4bf7 (0.13 with BUG-61 fixed;
74
+ ae95446 until 2026-10-18): `csrc/VENDORED.json` records
75
+ the commit and each file's sha256, `tests/test_vendored.py` checks them,
76
+ and `tools/vendor_drvec_c.py --repo --commit` refreshes the copy and the
77
+ manifest together. `setup.py` builds the executable (`csrc/build_drvec.py`:
78
+ the Makefile's units and flags, GSL static) into the package as
79
+ `drvec/_bin/drvec` (`drvec.exe`), which `c_engine` finds after
80
+ `DRVEC_BIN`. The wheels: `py3-none-<platform>` for Linux x86_64 and
81
+ aarch64 (manylinux, GSL 2.7.1 from source), macOS arm64 (the same) and
82
+ Windows AMD64 (MinGW-w64 and MSYS2's GSL, `-static`), plus the pure
83
+ `py3-none-any` wheel (`DRVEC_NO_C=1`) as the fallback and the sdist, which
84
+ builds the C when it finds a compiler and GSL. `DRVEC_REQUIRE_C=1` turns
85
+ a failed C build into an error (the wheels and the CI set it). On Linux
86
+ x86_64 the wheel's binary writes the oracle's files byte for byte
87
+ (`tests/test_bundled.py`, nineteen oracle commands); every wheel's smoke
88
+ test runs a bootstrap through it and the C-path tests. The CI no longer
89
+ builds the C from atsw-gui: it builds the vendored copy, on Windows too.
90
+ - **drvec C on Windows** (2026-10-18). drvec C 0.13 as vendored from ae95446
91
+ never finished a bootstrap on Windows: its two generators held their
92
+ 64-bit state in an `unsigned long`, 32 bits there (`bugs/drvec-c-rng-long32`,
93
+ found by the Windows wheel's smoke test). Fixed in the C as atsw-gui
94
+ BUG-61 (7ec4bf7, `uint64_t`), before drvec-v0.13's tag, and re-vendored. On
95
+ Linux x86_64 the fixed oracle writes ae95446's 83 files byte for byte
96
+ (`tests/data/oracle/SOURCE`). The Windows wheel is built again by publish.yml with
97
+ its smoke job, `c_engine.find()` no longer refuses drvec C on Windows (the
98
+ banner cannot tell the fixed build from the old one, so a hand-built
99
+ `DRVEC_BIN` from before the fix would still hang there), and tests.yml
100
+ builds the C on Windows (MinGW-w64, MSYS2's GSL).
101
+ - `c_engine.Job.wait` reads the growing `.boot` in binary, with its offset
102
+ in bytes (`bugs/py-boot-tail-crlf`). On Windows the C writes CRLF, text
103
+ mode delivered one character less per line than the bytes read, and the
104
+ next read began inside lines already delivered: `rank_test(engine="auto")`
105
+ failed on a fragment such as `8938564272` (tests.yml on windows-latest,
106
+ Python 3.10, the first run with the C there). Intermittent: it needs the C
107
+ to write between two polls.
108
+ - The package: Python on drvarma's exact likelihood and fue's reader.
109
+ Its oracle is drvec C 0.13 (atsw-gui ae95446; milestones 1-4 were
110
+ homologated against drvec-v0.12, which 0.13 reproduces on them).
111
+ - Milestone 1: the VEC cast (`vec_shootx`), the cold and Johansen starts, `est`
112
+ on drvarma's optimiser with the BFGS standard errors, the C's r = 0 ladder with
113
+ its entry gate, the route-(B) profile and the four-start search, the sequential
114
+ rank test with the parametric bootstrap and its `.boot` file. Public API:
115
+ `drvec.fit(pre_files, p, q, r, case=2)` and `drvec.rank_test(pre_files, p, q,
116
+ case=2, bootstrap=B)`. Homologated against the oracle's two milestone runs
117
+ (bit-identical except Johansen's eigenproblem, docs/PORT.md).
118
+ - `tools/time_bootstrap.py`: the bootstrap's cost against the C's, split into
119
+ the cast, the compiled likelihood and the rest; `--case e1` (M = 3).
120
+ - Milestone 2: the `.out` writer (`FitResult.out_text`, `RankTest.out_text`),
121
+ byte-identical to the oracle's on every PRE_CASE of its golden set;
122
+ `fit(..., fixb2row=, nodrift=, case="pre", trend=, xsys=, xpre=, xlink=,
123
+ irfboot=)`; Johansen's seed through GSL (ctypes) when libgsl is present
124
+ (from drvarma's engine since, below);
125
+ the tests exact on Linux x86_64 and on a tolerance tier elsewhere.
126
+ - Milestone 3: `fit(..., fdhess=True)` (the finite-difference Hessian s.e.),
127
+ `alpha=`, `weakex=`, `fixb2=` (restrictions with their LR against the free
128
+ model), `forecast=H` and `estwin=E` (`FitResult.forecast_text`,
129
+ `recursive_text`), `multistart=n` (also in `rank_test`), `drvec.rungs()`;
130
+ the command line `drvec-py` (the C's .pre-route syntax and products). Every
131
+ oracle case byte-identical on Linux x86_64. C defect found: -alpha accepts a
132
+ rank-deficient A (bugs/drvec-c-alpha-rank).
133
+ - Milestone 4: `rank_test(..., case="pre")` and `rank_test(..., nodrift=[i])`
134
+ (also with `bootstrap=N`; the CLI's `-lrtest -case pre`/`-nodrift`, with the
135
+ C's warning on the mixed case); the entry gate with its optimality
136
+ certificate in a plain fit at the diagonal rung (`FitResult.gate`). Every
137
+ oracle case byte-identical on Linux x86_64 but one bootstrap replication of
138
+ cprboot.boot, where the C reuses the previous replication's ladder: C defect
139
+ bugs/drvec-c-ladder-key.
140
+ - Milestone 5: deterministic variables in a `.pre` (impulse, compimp, step,
141
+ ramp, easter, trend, cos, sin, alter): each file's component subtracted from
142
+ w and added back to the forecasts in levels; `-xpre` inputs with an ARMA
143
+ model (the presample backcast, xl_backcast) and with deterministic
144
+ variables. The `.pre` files are read and cast by fue (`fue.load`,
145
+ `fue.cast_us.cast_us_py` with the non-stationary operator emptied:
146
+ `drvec.data.levels_cast`), as in drtran-python; fue is a runtime dependency.
147
+ (A first version transcribed the C's reader, `drvec.prefile`; it was
148
+ removed.) The component follows fue's rule (a rational term truncated at
149
+ 40 lags, the variables summed and subtracted once), and every oracle case
150
+ is byte-identical on Linux x86_64 with GSL, the BUG-40 case included (b40,
151
+ b40rank: a step with delta 0.95, 52 periods on).
152
+ - The oracle is drvec C 0.13 (atsw-gui ae95446; the tag drvec-v0.13 comes
153
+ with the release) and fue is required at >= 0.1.18: both build a .pre's
154
+ deterministic component with the suite's one routine (atsw-gui
155
+ lib/fuedet). BUG-40 -- drvec C 0.12 applied the exact filter where fue
156
+ truncates at 40 lags, and fue <= 0.1.17 subtracted one variable at a time
157
+ -- is closed by agreeing with fue. Milestone 5's oracle files regenerated
158
+ (24 of 30; those of milestones 1-4, without deterministic variables, are
159
+ byte-identical under 0.13 and were kept); the BYTE/FUE split of
160
+ tests/test_m5.py and tests/cdet.py, the C's old exact component, removed.
161
+ - Johansen's seed and the printed eigenvalues come from GSL through
162
+ drvarma's compiled engine (`drvarma._engine.gensymmv` and `eigen_nonsymm`,
163
+ drvarma >= 0.3.0), on every platform drvarma ships a binary wheel for;
164
+ `drvec._gsl` no longer looks for a system libgsl through ctypes, and the CI
165
+ installs none. Without drvarma's engine, scipy's `eigh` and numpy's
166
+ `eigvals` as before (decided 2026-10-15, TODO.md). Verified bit-identical
167
+ to the ctypes path on Linux x86_64 before removing it: the full suite with
168
+ `--runslow`, with every call solved both ways and compared with `==` --
169
+ 271 generalized eigenproblems (190 with M = 2, 81 with M = 3) and 117
170
+ nonsymmetric ones (n = 2, 3, 4, 6), all equal; the suite is unchanged,
171
+ byte-identical to the oracle.
172
+ - Packaging for PyPI (not published; the suite is released together): the
173
+ name `drvec`, the metadata (description, keywords, classifiers for Python
174
+ 3.10-3.13, URLs, `license-files`), `MANIFEST.in` (the sdist carries the
175
+ docs and the test suite with its public data; not TODO.md, tools/, bugs/),
176
+ a README for the PyPI page with absolute links, and `publish.yml`: on a
177
+ `v*` tag, the platform wheels (above), the pure wheel and the sdist,
178
+ `twine check`, a check that nothing private ships, every one
179
+ smoke-tested on Python 3.10 and 3.13, then trusted publishing. The tests can run against the installed package
180
+ (`DRVEC_TEST_INSTALLED=1`; the CI does), and `tests.yml` has a manual run
181
+ that builds fue and drvarma from git refs, to measure off the oracle's
182
+ platform before they are released.
183
+ - **What sima 0.2.0 needs from the engine** (PLAN-vec A1-A3, B; none of it
184
+ changes a number: the suite is byte-identical to the oracle as before).
185
+ - The accessors (A1): `FitResult.alpha`, `beta2`, `beta`, `Pi`, `gamma`,
186
+ `theta`, `Q`, `Sigma`, `means`, `delta`, `residuals` (with
187
+ `residual_names`), `stationary` (the VARMA on Ybar); `level_irf(K)`,
188
+ `fevd(K)`, `long_run()` (gain, mean lag); `irf_bands()`;
189
+ `diagnostics()` (Hosking's Q and the multivariate JB with their df and
190
+ p-values); `forecasts(H)` (point, bands, s.e. and dates); and
191
+ `restriction_lr` (the LR with its df and p-value). Each comes from the
192
+ routine that prints it (`report.level_irf_numbers`,
193
+ `multivariate_numbers`, `restriction_lr`; `forecast.forecast_arrays`,
194
+ from which `forecast_vec` prints the files), and `tests/test_accessors.py`
195
+ checks every one against the printed number on every golden fit.
196
+ - The parallel bootstrap (A2): `rank_test(..., workers=)` and
197
+ `fit(..., irfboot=N, workers=)`. The samples are drawn in sequence, in the
198
+ C's order, and refitted in a process pool (`drvec.parallel`); a refit
199
+ draws no random numbers (checked: the only consumer of the generator is
200
+ `simulate_h0`), so `workers=1` and `workers=4` give the same `.out`,
201
+ `.boot` and `.irfboot` byte for byte (`tests/test_parallel.py`). Default
202
+ `DRVEC_WORKERS`, else the cores less one. The `-irfboot` bootstrap gains
203
+ `progress(b, ok)`; the rank test's `progress` is now also called for a
204
+ replication whose sample could not be drawn (simfail).
205
+ - `seed=` on both bootstraps (A3), the C's 987654321 by default.
206
+ - drvec C as the bootstrap engine (B): `drvec.c_engine` finds the binary
207
+ (`DRVEC_BIN`, a binary bundled at `drvec/_bin/drvec`, `drvec` on the PATH,
208
+ the ATSW install directory), refuses any version but 0.13, translates the
209
+ call into the C's argv (the inverse of the CLI's parser), runs it in a
210
+ folder and reads its `.boot` and `.irfboot` back into the same
211
+ `RankTest`/`FitResult`. `engine="auto" | "python" | "c"` on both
212
+ bootstraps (`DRVEC_ENGINE`; "auto" takes the C when it matches). Every
213
+ result carries `provenance` (engine, version, path, backend, platform
214
+ tier, workers, seed). On Linux x86_64 the two engines give the same bytes
215
+ (`tests/test_c_engine.py`), except the C's BUG-60 replication of cprboot.
216
+ - `docs/API.md`; `tools/time_bootstrap.py --engines` measures the engines.
drvec-0.1.0/COPYING ADDED
@@ -0,0 +1,339 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License along
307
+ with this program; if not, write to the Free Software Foundation, Inc.,
308
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309
+
310
+ Also add information on how to contact you by electronic and paper mail.
311
+
312
+ If the program is interactive, make it output a short notice like this
313
+ when it starts in an interactive mode:
314
+
315
+ Gnomovision version 69, Copyright (C) year name of author
316
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317
+ This is free software, and you are welcome to redistribute it
318
+ under certain conditions; type `show c' for details.
319
+
320
+ The hypothetical commands `show w' and `show c' should show the appropriate
321
+ parts of the General Public License. Of course, the commands you use may
322
+ be called something other than `show w' and `show c'; they could even be
323
+ mouse-clicks or menu items--whatever suits your program.
324
+
325
+ You should also get your employer (if you work as a programmer) or your
326
+ school, if any, to sign a "copyright disclaimer" for the program, if
327
+ necessary. Here is a sample; alter the names:
328
+
329
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
331
+
332
+ <signature of Ty Coon>, 1 April 1989
333
+ Ty Coon, President of Vice
334
+
335
+ This General Public License does not permit incorporating your program into
336
+ proprietary programs. If your program is a subroutine library, you may
337
+ consider it more useful to permit linking proprietary applications with the
338
+ library. If this is what you want to do, use the GNU Lesser General
339
+ Public License instead of this License.
@@ -0,0 +1,34 @@
1
+ # The sdist carries the package, its documentation and the test suite with its
2
+ # PUBLIC data (Jenkins and Alavi's muskrat and mink, Lutkepohl's E1, and the
3
+ # oracle's outputs on them), so that it can test itself without the repository.
4
+ # Listed one by one, and what does not ship is excluded explicitly: `include`
5
+ # only adds, and an old egg-info's SOURCES.txt drags in whatever was once in.
6
+ #
7
+ # csrc/ ships: the vendored C sources the sdist builds drvec/_bin/drvec from
8
+ # (setup.py, csrc/build_drvec.py), with their manifest; a locally built
9
+ # binary in src/drvec/_bin does not.
10
+ #
11
+ # Not shipped: TODO.md (a working record: milestones, measurements, the runs on
12
+ # a private article's inputs, of which nothing is in the repository either),
13
+ # tools/ (the bootstrap timing, against those runs' C times), bugs/ (the repros
14
+ # of the C program's defects: they belong to the C, atsw-gui) and any notes.
15
+ include README.md
16
+ include CHANGELOG.md
17
+ include COPYING
18
+ include docs/PORT.md
19
+ include docs/API.md
20
+ include setup.py
21
+ recursive-include csrc *
22
+ recursive-include tests *.py
23
+ recursive-include tests/data *
24
+ prune tests/__pycache__
25
+ global-exclude *.py[cod] __pycache__
26
+
27
+ exclude TODO.md
28
+ prune tools
29
+ prune bugs
30
+ prune build
31
+ prune dist
32
+ prune src/drvec/_bin
33
+ global-exclude *.o
34
+ exclude docs/PROCESOS-drvec.md