diff options
author | Gard Spreemann <gspreemann@gmail.com> | 2016-03-22 16:14:10 +0100 |
---|---|---|
committer | Gard Spreemann <gspreemann@gmail.com> | 2016-03-22 16:14:10 +0100 |
commit | f95c4cd479caabf54d425b3f62901f977098abe0 (patch) | |
tree | 5e8ccae84112b5194fe6ef2ac9a831682e737463 /README.md |
Initial commit with basic stuff from messy scripts.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..7bb5c22 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +Introduction +===== + +This package is a cleaned up subset of the hogdepodge of the Python +glue that I regularly use to massage data into and out of persistent +homology and other TDA computations. It does *not* compute anything +itself, and exists primarily to marshal data into and out of the +formats used by the excellent [DIPHA](https://github.com/DIPHA/dipha) +software, in order to make it easier to pre- and post-process data in +Python. + +Caveats +----- + +I decided to clean up and release a subset of these scripts to make +life slightly easier for those who compute persistent homology and +prefer to manipulate data in Python. The scripts come with the +following caveats: + +- The scripts were too messy to release as they were, and the cleaning + up process means that this is now essentially untested software + again. Beware. + +- There is nothing of substance here. This is just glue around + [DIPHA](https://github.com/DIPHA/dipha). + +- I use Python as modern Perl, and my experience with it is limited to + quickly manipulating data without too much thought for writing + structured software. Beware. + +- I make no attempt to accurately reflect the full capabilities of + [DIPHA](https://github.com/DIPHA/dipha). + +- Since Python will let you write `Interval("banana", 5)`, so will I, + and you and your persistence generator "from banana to 5" can go + solve problems down the road. + + +Installation +===== + +FIXME. + + +Use +===== + +FIXME. |