From 630ca19980490a8c0feaed7fc8e9492fa4e21b8a Mon Sep 17 00:00:00 2001 From: Dominic Steinitz Date: Sat, 21 Apr 2018 08:37:47 +0100 Subject: Improve READMEs etc --- packages/sundials/ChangeLog.md | 6 +++--- packages/sundials/README.md | 22 +++++++--------------- 2 files changed, 10 insertions(+), 18 deletions(-) (limited to 'packages/sundials') diff --git a/packages/sundials/ChangeLog.md b/packages/sundials/ChangeLog.md index e95dc4e..7b15777 100644 --- a/packages/sundials/ChangeLog.md +++ b/packages/sundials/ChangeLog.md @@ -1,5 +1,5 @@ -# Revision history for sundials +# Revision history for hmatrix-sundials -## 0.1.0.0 -- YYYY-mm-dd +## 0.1.0.0 -- 2018-04-21 -* First version. Released on an unsuspecting world. +* First version. Released on an unsuspecting world. Just Runge-Kutta methods to start with. diff --git a/packages/sundials/README.md b/packages/sundials/README.md index 400b36f..2fac5c2 100644 --- a/packages/sundials/README.md +++ b/packages/sundials/README.md @@ -1,16 +1,8 @@ -I think this builds the executable. I haven't tried cleaning -everything yet to double check. +Currently only an interface to the Runge-Kutta methods: +[ARKode](https://computation.llnl.gov/projects/sundials/arkode) -``` -cabal install -cd src -/nix/store/qrwfai93qhdaj5d4xd34n9bq58slzfxw-gcc-wrapper-6.4.0/bin/gcc -c helpers.c -I/nix/store/dr0yrlmscybjs5ifzw1m063g6xgw5imq-ghc-8.2.2-with-packages/lib/ghc-8.2.2/include -cd .. -ghc src/Main.hs src/helpers.o -lsundials_arkode -o Main -``` - -To run you will (on MACos) also need - -``` -export DYLD_LIBRARY_PATH=~/.cabal/bin:/nix/store/dr0yrlmscybjs5ifzw1m063g6xgw5imq-ghc-8.2.2-with-packages/lib/ghc-8.2.2/rts -``` \ No newline at end of file +The interface is almost certainly going to change. Sundials gives a +rich set of "combinators" for controlling the solution of your problem +and reporting on how it performed. The idea is to initially mimic +hmatrix-gsl and add extra, richer functions but ultimately upgrade the +whole interface both for sundials and for gsl. -- cgit v1.2.3