Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What does the example do? #10

Closed
gdalle opened this issue May 17, 2024 · 7 comments
Closed

What does the example do? #10

gdalle opened this issue May 17, 2024 · 7 comments

Comments

@gdalle
Copy link
Collaborator

gdalle commented May 17, 2024

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
Copy link
Member

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

@gdalle
Copy link
Collaborator Author

gdalle commented May 18, 2024

I removed it in #11

@amontoison
Copy link
Member

amontoison commented May 18, 2024

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
Copy link
Collaborator Author

gdalle commented May 18, 2024

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
Copy link
Member

amontoison commented May 18, 2024

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

@gdalle
Copy link
Collaborator Author

gdalle commented May 18, 2024

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
Copy link
Member

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

@gdalle gdalle linked a pull request Jun 11, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants