Skip to content

Commit

Permalink
MATLAB_Tools: comments and file locations
Browse files Browse the repository at this point in the history
  • Loading branch information
DrTimothyAldenDavis committed Oct 31, 2023
1 parent 48fe2f7 commit 1b7c895
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
21 changes: 11 additions & 10 deletions MATLAB_Tools/SuiteSparseCollection/README.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
SuiteSparseCollection, Copyright (c) 2006-2019, Timothy A Davis.
SuiteSparseCollection, Copyright (c) 2006-2023, Timothy A Davis.
All Rights Reserved.
SPDX-License-Identifier: GPL-2.0+

Expand Down Expand Up @@ -46,7 +46,6 @@ SuiteSparseCollection: software for managing the SuiteSparse Matrix Collection

Requires ssget, CSparse, CHOLMOD, AMD, COLAMD, RBio, and METIS.


--------------------------------------------------------------------------------
Files:
--------------------------------------------------------------------------------
Expand Down Expand Up @@ -81,26 +80,26 @@ Requires most of SuiteSparse (ssget, CHOLMOD, AMD, COLAMD, CSparse, RBio, and
SuiteSparseCollection), and METIS.

The location of the primary archive of the collection is
backslash.cse.tamu.edu:/archive/davis/SuiteSparseCollection,
backslash.engr.tamu.edu:/raid/SuiteSparseCollection,
which is only accessible to the maintainers of the collection.

A local copy of ssget should be installed where the mat, MM, RB, and svd
directories are replaced with symbolic links to the directories in
backslash.cse.tamu.edu:/archive/davis/SuiteSparseCollection. The
backslash.engr.tamu.edu:/raid/SuiteSparseCollection. The
ssget/files directory should not be a symbolic link.

1) Get the matrix into MATLAB (method depending on how the matrix was
submitted). Use load and sparse2, RBread, mread, or specialized code
written just for that matrix.

2) Add the full matrix name to the end of the file:
backslash:/archive/davis/SuiteSparseCollection/files/ss_listing.txt
backslash:/raid/SuiteSparseCollection/files/ss_listing.txt
Each line in the file has the form Group/Name. The line number in
ss_listing.txt must match the matrix Problem.id number, and full name
must match the Problem.name in the MATLAB struct.

3) Create a new directory
backslash:/archive/davis/SuiteSparseCollection/mat/Group,
backslash:/raid/SuiteSparseCollection/mat/Group,
where Group is the new matrix group. Add a README.txt file to this
directory, the first line of which is a one-line summary that will appear
in the top-level web page for the collection. Skip this step if adding a
Expand All @@ -123,7 +122,9 @@ ssget/files directory should not be a symbolic link.
Problem.b right-hand-side
Problem.x solution
Problem.notes a char array
Problem.aux auxiliary matrices (contents are problem dependent)
Problem.aux auxiliary matrices (contents are problem dependent).
Sequences of k matrices should be held as cell arrays,
of size k-by-1.

Save to a MATLAB mat-file. In the mat directory, do this in MATLAB:

Expand All @@ -134,7 +135,7 @@ ssget/files directory should not be a symbolic link.
save (Problem.name, 'Problem', '-v7.3') ;

Move the new *.mat files into
backslash:/raid/SuiteSparseCollection/html//mat/Group.
backslash:/raid/SuiteSparseCollection/html/mat/Group.

5) Compute matrix statistics and extend the ss_index. Do this in MATLAB:

Expand All @@ -143,7 +144,7 @@ ssget/files directory should not be a symbolic link.
where ids is a list of the new matrix id's. Updated ss_index.mat and
ssstats.csv files are placed in the current working directory.
Move the new ss_index.mat and ssstats.csv files to
backslash:/archive/davis/SuiteSparseCollection/files,
backslash:/raid/SuiteSparseCollection/files,
overwriting the old copies there. Also copy them into
[path to ssget]/files/ so they will be found by the MATLAB ssget.m.

Expand Down Expand Up @@ -172,7 +173,7 @@ ssget/files directory should not be a symbolic link.
sspages (ids)

8) Make the collection world-readable. In
backslash:/archive/davis/SuiteSparseCollection/ do:
backslash:/raid/SuiteSparseCollection/ do:

chmod -R og+rX mat files MM RB

Expand Down
8 changes: 4 additions & 4 deletions MATLAB_Tools/SuiteSparseCollection/sslocation.m
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
% All Rights Reserved.
% SPDX-License-Identifier: GPL-2.0+

% on backslash.cse.tamu.edu:
topdir = '/archive/davis/SuiteSparseCollection/' ;
% on backslash.engr.tamu.edu:
topdir = '/raid/SuiteSparseCollection/html/' ;

% on hypersparse.cse.tamu.edu:
topdir = '/raid/archive/davis/SuiteSparseCollection/' ;
% on hypersparse.engr.tamu.edu:
topdir = '/raid/SuiteSparseCollection/html/' ;

0 comments on commit 1b7c895

Please sign in to comment.