Mercurial > hg > numerics

annotate README.txt @ 193:dc495f0b5ee8 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[testing] toxify
author Jeff Hammel <k0scist@gmail.com>
date Sun, 13 Aug 2017 15:52:01 -0700
parents 2a69ce7f944e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
35
f1168ca2aa4c libraries
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
1 = numerics =
f1168ca2aa4c libraries
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
2
f1168ca2aa4c libraries
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
3 /python experiments in numerics + plotting/
f1168ca2aa4c libraries
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
4
191
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
5 == What is numerics? ==
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
6
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
7 Over the years and at various companies, I have found the need to
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
8 perform quick pipelines of calculations on mathematical data (usually
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
9 numbers). The `numerics`
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
10 [python package](https://pypi.python.org/pypi/numerics)
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
11 is an assemblege of tools and methods needed to scratch this issue.
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
12 It is neither scoped nor complete.
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
13
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
14 `numerics` largely deals in the currency of Comma Separated Value (CSV)
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
15 files.
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
16
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
17 == Dependencies ==
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
18
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
19 The backbone of `numerics` are its dependencies, which I have either
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
20 used + liked or just used:
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
21
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
22 - [NumPy](http://www.numpy.org/)
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
23 - [pandas](http://pandas.pydata.org/) : python data analysis
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
24 - [matplotlib](https://matplotlib.org/)
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
25 - [bokeh](http://bokeh.pydata.org/en/latest/) : because I couldn't
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
26 decide which visualization library I *actually* wanted
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
27
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
28 These dependencies are (mostly) listed in `numerics`'s
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
29 [setup.py](http://k0s.org/hg/numerics/file/tip/setup.py)
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
30
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
31
174
Jeff Hammel <k0scist@gmail.com>
parents: 143
diff changeset
32 == Installation ==
Jeff Hammel <k0scist@gmail.com>
parents: 143
diff changeset
33
176
f9c87cba1df3 clean off some dust
Jeff Hammel <k0scist@gmail.com>
parents: 174
diff changeset
34 Because `numerics` is largely a bunch of experiments, it requires
f9c87cba1df3 clean off some dust
Jeff Hammel <k0scist@gmail.com>
parents: 174
diff changeset
35 several packages. Some of them *may* be challenging to install.
f9c87cba1df3 clean off some dust
Jeff Hammel <k0scist@gmail.com>
parents: 174
diff changeset
36 Here's how, as best I know.
f9c87cba1df3 clean off some dust
Jeff Hammel <k0scist@gmail.com>
parents: 174
diff changeset
37
191
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
38 I have found it necessary to `pip install bokeh` before
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
39 the rest of numerics...otherwise a version conflict re `pytz` may result.
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
40
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
41 Then one may do `python setup.py develop` in the `numerics` directory
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
42
174
Jeff Hammel <k0scist@gmail.com>
parents: 143
diff changeset
43 === OSX ===
Jeff Hammel <k0scist@gmail.com>
parents: 143
diff changeset
44
191
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
45 For [matplotlib](https://matplotlib.org/):
177
c2c86c37eadd this now works on Mac
Jeff Hammel <k0scist@gmail.com>
parents: 176
diff changeset
46
174
Jeff Hammel <k0scist@gmail.com>
parents: 143
diff changeset
47 http://superuser.com/questions/242190/how-to-install-matplotlib-on-os-x
Jeff Hammel <k0scist@gmail.com>
parents: 143
diff changeset
48
177
c2c86c37eadd this now works on Mac
Jeff Hammel <k0scist@gmail.com>
parents: 176
diff changeset
49 You may also have to manually refresh the font cache:
c2c86c37eadd this now works on Mac
Jeff Hammel <k0scist@gmail.com>
parents: 176
diff changeset
50
c2c86c37eadd this now works on Mac
Jeff Hammel <k0scist@gmail.com>
parents: 176
diff changeset
51 cd ~/.matplotlib/
c2c86c37eadd this now works on Mac
Jeff Hammel <k0scist@gmail.com>
parents: 176
diff changeset
52 fc-list # Should take a couple minutes.
c2c86c37eadd this now works on Mac
Jeff Hammel <k0scist@gmail.com>
parents: 176
diff changeset
53
c2c86c37eadd this now works on Mac
Jeff Hammel <k0scist@gmail.com>
parents: 176
diff changeset
54 (From: http://stackoverflow.com/questions/17490444/import-matplotlib-pyplot-hangs )
c2c86c37eadd this now works on Mac
Jeff Hammel <k0scist@gmail.com>
parents: 176
diff changeset
55
191
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
56
192
2a69ce7f944e stub on testing
Jeff Hammel <k0scist@gmail.com>
parents: 191
diff changeset
57 == Testing ==
2a69ce7f944e stub on testing
Jeff Hammel <k0scist@gmail.com>
parents: 191
diff changeset
58
2a69ce7f944e stub on testing
Jeff Hammel <k0scist@gmail.com>
parents: 191
diff changeset
59 Use `pytest` + `tox` per usual
2a69ce7f944e stub on testing
Jeff Hammel <k0scist@gmail.com>
parents: 191
diff changeset
60
35
f1168ca2aa4c libraries
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
61 == Libraries ==
0
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
62
35
f1168ca2aa4c libraries
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
63 The following libraries, listed by language, may be worth investigating.
f1168ca2aa4c libraries
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
64
191
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
65
35
f1168ca2aa4c libraries
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
66 === JavaScript ===
f1168ca2aa4c libraries
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
67
f1168ca2aa4c libraries
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
68 - http://metricsgraphicsjs.org/
143
Jeff Hammel <k0scist@gmail.com>
parents: 35
diff changeset
69 - https://github.com/mikedewar/d3py : python -> d3 bridge
0
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
70
191
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
71
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
72 == Links ==
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
73
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
74 - https://scipy.org/
09bcb48cc067 [documentation] more on what this is and what it depends on
Jeff Hammel <k0scist@gmail.com>
parents: 177
diff changeset
75
0
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
76 ----
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
77
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
78 Jeff Hammel
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
79
35
f1168ca2aa4c libraries
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
80 http://k0s.org/hg/numerics
0
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
81