From d72f1270e447dde65f727a7e761dad8d10e64575 Mon Sep 17 00:00:00 2001 From: Tim Quatmann Date: Tue, 19 May 2020 14:03:37 +0200 Subject: [PATCH] Added some documentation for steps on how to update a resource. --- doc/update_resources.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 doc/update_resources.md diff --git a/doc/update_resources.md b/doc/update_resources.md new file mode 100644 index 000000000..e1b85e8c1 --- /dev/null +++ b/doc/update_resources.md @@ -0,0 +1,16 @@ +# Update shipped third party resources + +## Eigen + +In Eigen, we have adapted `SparseLU` to work with scalar types that do not default construct from a double (like CLN numbers) or that do not have an operator< or std::abs + +To update the Eigen version, just change the corresponding commit hash in `$STORM_DIR/resources/3rdparty/CmakeLists.txt`. +Check whether the patch located at `$STORM_DIR/resources/3rdparty/patches/eigen.patch` can be applied without issues (in particular check for changes in `Eigen/src/SparseLU/`) + +In case a new patch needs to be created follow these steps: + +1. Clone `https://gitlab.com/libeigen/eigen.git` to `$STORM_DIR/resources/3rdparty/` and checkout the corresponding commit +2. Checkout a new branch +3. Apply the old patch via `git apply $STORM_DIR/resources/3rdparty/patches/eigen.patch` +4. Resolve issues, make changes, and commit them +5. Create a new patch file via `git format-patch --stdout > eigen.patch`, where `` is the tag, branch or commit from step 1 \ No newline at end of file