This is the manual for the GraphSym package version 0.1.
The GraphSym package contains various collections of graphs with interesting symmetry properties. Each collection of graphs are attained from complete or partial enumerations published in international journals. The papers containing these enumerations are referenced throughout this document, and their authors are included as contributors (unless they are an author of this package). The GraphSym package provides functionality enabling easy access to these graphs, along with several precomputed properties related to many of the graphs stored within.
Currently, all of the functions in this package deal with finite graphs in Digraphs format [DBJM+19], and much of the functionality provided is based on the very nice code found in Digraphs: Visualising and IO.
To install the GraphSym package, you first need to download or clone the package, found at https://rhysje00.github.io/graphsym/. Once downloaded, there is no need for any extra compiling. If possible, it is recommended that you place the GraphSym directory into the package directory of your GAP distribution. For guidance on how to load GraphSym package if you cannot move the directory directly into your GAP package directory, see Section 1.3.
The GraphSym package requires the following GAP packages:
Each of the above packages are part of the standard GAP distribution.
Once downloaded, you can build all package documentation by running gap path/to/graphsym/makedoc.g from the command line. This will build a pdf version of this manual and save it in the directory path/to/graphsym/doc/, as well as provide the GAP help viewer with the content of the manual.
If the GraphSym package has been downloaded and placed in the GAP package directory, it can by loaded at the GAP prompt by typing the following.
gap> LoadPackage("graphsym"); true
Otherwise, you can follow the methods found in the GAP reference manual, chapter 76. For example, if path/to/graphsym is the path to the GraphSym package directory relative to your GAP session, it can be loaded at the GAP prompt by typing the following.
gap> SetPackagePath("graphsym","path/to/graphsym"); gap> LoadPackage("graphsym"); true
If you use the GraphSym package in your research, please tell us about it by emailing rhysjevans00@gmail.com. We are interested in any research involving the use of the GraphSym package and might refer to your work in the future. If you wish to refer to the GraphSym package in a published work, please cite GraphSym like a journal article. The following is a BibTeX entry for the current GraphSym version:
@Manual{cvt,
author = {Evans, Rhys J. and Montero, Antonio and
Poto\v{c}nik, Primo\v{z}},
key = {cvt},
title = {{GraphSym -- GRaphs with SYmmetries LIbrary for GAP,
Version 0.1}},
url = {\verb+(https://rhysje00.github.io/graphsym/)+},
year = {2024}
generated by GAPDoc2HTML