exanauts / ColPack.jl

A Julia interface to the C++ library ColPack for graph and sparse matrix coloring.
https://exanauts.github.io/ColPack.jl/
MIT License
6 stars 0 forks source link

What does the example do? #10

Closed gdalle closed 3 weeks ago

gdalle commented 1 month ago

The file https://github.com/michel2323/ColPack.jl/blob/master/examples/coloring.jl doesn't seem to be used anywhere, and it tries to read a matrix from a file without downloading it first

michel2323 commented 1 month ago

That's indeed messy. ColPack has an mtx reader.

gdalle commented 1 month ago

I removed it in #11

amontoison commented 1 month ago

We should keep it in a section of the documentation. It is always useful to have a script to try the algorithm directly on mtx files.

gdalle commented 1 month ago

Okay but this script doesn't run anyway since the downloading part is not written. Feel free to add something that uses e.g. https://github.com/JuliaLinearAlgebra/MatrixDepot.jl

amontoison commented 1 month ago

Ok I was not aware of that. It's a good idea to remove the file in that case.

gdalle commented 1 month ago

I want to add more docs anyway once I figure out how the package works (e.g. with #12). I can always add an example where a matrix is downloaded from the sparse matrix connection, stored in mtx and then retrieved. But I want it to actually run in the docs, not just be some displayed code

amontoison commented 1 month ago

The package SuiteSparseMatrixCollection.jl can download and install the mtx files for you as an artifact.