Skip to content

Commit

Permalink
Merge pull request #141 from gap-packages/release
Browse files Browse the repository at this point in the history 
Release xmod-2.92
  • Loading branch information
@cdwensley
cdwensley authored Jan 23, 2024
2 parents 3f210cc + 6125dac commit 5067ceb
Show file tree
Hide file tree
Showing 4 changed files with 398 additions and 546 deletions.
3 changes: 2 additions & 1 deletion CHANGES.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# CHANGES to the 'XMod' package

## 2.91 -> 2.91dev (16/02/2023)
## 2.91 -> 2.92 (23/01/2024)
* (11/10/23) methods for WhiteheadXMod etc for xmods which arent perm xmods
* (16/02/23) now using the NC version of PreImagesRepresentative

## 2.89 -> 2.91 (16/02/2023)
Expand Down
6 changes: 3 additions & 3 deletions PackageInfo.g
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ SetPackageInfo( rec(

PackageName := "XMod",
Subtitle := "Crossed Modules and Cat1-Groups",
Version := "2.91dev",
Date := "16/02/2023", # dd/mm/yyyy format
Version := "2.92",
Date := "23/01/2024", # dd/mm/yyyy format
License := "GPL-2.0-or-later",

Persons := [
Expand Down Expand Up @@ -129,7 +129,7 @@ Keywords := ["crossed module", "cat1-group", "derivation", "section",
AutoDoc := rec(
TitlePage := rec(
Copyright := Concatenation(
"&copyright; 1996-2023, Chris Wensley et al. <P/>\n",
"&copyright; 1996-2024, Chris Wensley et al. <P/>\n",
"The &XMod; package is free software; you can redistribute it ",
"and/or modify it under the terms of the GNU General ",
"Public License as published by the Free Software Foundation; ",
Expand Down
260 changes: 60 additions & 200 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,200 +1,60 @@
#############################################################################
##
## PackageInfo.g file for the package XMod
## Chris Wensley et al

SetPackageInfo( rec(

PackageName := "XMod",
Subtitle := "Crossed Modules and Cat1-Groups",
Version := "2.88dev",
Date := "01/02/2023", # dd/mm/yyyy format
License := "GPL-2.0-or-later",

Persons := [
rec(
LastName := "Wensley",
FirstNames := "Chris",
IsAuthor := true,
IsMaintainer := true,
Email := "[email protected]",
WWWHome := "https://github.com/cdwensley",
Place := "Llanfairfechan"
),
rec(
LastName := "Alp",
FirstNames := "Murat",
IsAuthor := true,
IsMaintainer := false,
Email := "[email protected]",
PostalAddress := Concatenation( [
"Prof. Dr. M. Alp\n",
"Ömer Halisdemir University\n",
"Art and Science Faculty\n",
"Mathematics Department\n",
"Nigde\n",
"Turkey"] ),
Place := "Nigde",
Institution := "Ömer Halisdemir University"
),
rec(
LastName := "Odabas",
FirstNames := "Alper",
IsAuthor := true,
IsMaintainer := false,
Email := "[email protected]",
PostalAddress := Concatenation( [
"Dr. A. Odabas \n",
"Osmangazi University \n",
"Arts and Sciences Faculty \n",
"Department of Mathematics and Computer Science \n",
"Eskisehir \n",
"Turkey"] ),
Place := "Eskisehir",
Institution := "Osmangazi University"
),
rec(
LastName := "Uslu",
FirstNames := "Enver Onder",
IsAuthor := true,
IsMaintainer := false
)
],

Status := "accepted",
CommunicatedBy := "Derek Holt (Warwick)",
AcceptDate := "12/1996",

SourceRepository := rec(
Type := "git",
URL := "https://github.com/gap-packages/xmod" ),
IssueTrackerURL := Concatenation( ~.SourceRepository.URL, "/issues" ),
PackageWWWHome := "https://gap-packages.github.io/xmod/",
README_URL := Concatenation( ~.PackageWWWHome, "README.md" ),
PackageInfoURL := Concatenation( ~.PackageWWWHome, "PackageInfo.g" ),
ArchiveURL := Concatenation( ~.SourceRepository.URL,
"/releases/download/v", ~.Version,
"/", ~.PackageName, "-", ~.Version ),

SupportEmail := "[email protected]",
ArchiveFormats := ".tar.gz",

AbstractHTML :=
"The <span class=\"pkgname\">XMod</span> package provides a collection \
of functions for computing with crossed modules and cat1-groups, \
their derivations and sections, morphisms of these structures, \
and higher-dimensional generalisations.",

PackageDoc := rec(
BookName := "XMod",
ArchiveURLSubset := ["doc"],
HTMLStart := "doc/chap0_mj.html",
PDFFile := "doc/manual.pdf",
SixFile := "doc/manual.six",
LongTitle := "Crossed Modules and Cat1-Groups in GAP",
Autoload := true
),

Dependencies := rec(
GAP := ">=4.11.0",
NeededOtherPackages := [ ["utils", ">= 0.76"],
["groupoids", ">= 1.68"],
["HAP", ">= 1.29"],
["AutPGrp", ">= 1.10.2"],
["SmallGrp", ">= 1.4.2" ] ],
SuggestedOtherPackages := [ ],
ExternalConditions := [ ]
),

AvailabilityTest := ReturnTrue,

BannerString := Concatenation(
"Loading XMod ", String( ~.Version ),
" (methods for crossed modules and cat1-groups)\n",
"by Chris Wensley (https://github.com/cdwensley),\n",
" with contributions from:\n",
" Murat Alp ([email protected]),\n",
" Alper Odabas ([email protected]),\n",
"and Enver Uslu.\n",
"----------",
"-------------------------------------------------------------------\n" ),

Autoload := false,

TestFile := "tst/testall.g",

Keywords := ["crossed module", "cat1-group", "derivation", "section",
"actor", "crossed square" ],

AutoDoc := rec(
TitlePage := rec(
Copyright := Concatenation(
"&copyright; 1996-2023, Chris Wensley et al. <P/>\n",
"The &XMod; package is free software; you can redistribute it ",
"and/or modify it under the terms of the GNU General ",
"Public License as published by the Free Software Foundation; ",
"either version 2 of the License, or (at your option) ",
"any later version.\n"
),
Abstract := Concatenation(
"The &XMod; package provides functions for computation with\n",
"<List>\n",
" <Item>\n",
" finite crossed modules of groups and cat1-groups, \n",
" and morphisms of these structures; \n",
" </Item>\n",
" <Item>\n",
" finite pre-crossed modules, pre-cat1-groups, ",
" and their Peiffer quotients;\n",
" </Item>\n",
" <Item>\n",
" isoclinism classes of groups and crossed modules; \n",
" </Item>\n",
" <Item>\n",
" derivations of crossed modules and sections of cat1-groups; \n",
" </Item>\n",
" <Item>\n",
" crossed squares and their morphisms, ",
" including the actor crossed square of a crossed module; \n",
" </Item>\n",
" <Item>\n",
" crossed modules of finite groupoids (experimental version). \n",
" </Item>\n",
"</List>\n",
"<P/>\n",
"&XMod; was originally implemented in 1996 using the &GAP;3 ",
"language, when the second author was studying for a Ph.D. ",
"<Cite Key='A1'/> at Bangor.\n",
"<P/>\n",
"In April 2002 the first and third parts were converted ",
"to &GAP;4, the pre-structures were added, ",
"and version 2.001 was released. \n",
"The final two parts, covering derivations, sections and actors, ",
"were included in the January 2004 release 2.002 for &GAP; 4.4.\n",
"<P/>\n",
"In October 2015 functions for computing isoclinism classes of ",
"crossed modules, written by Alper Odaba&#x15f; and Enver Uslu, ",
"were added.\n",
"These are contained in Chapter <Ref Chap='chap-isclnc' />, ",
"and are described in detail in the paper <Cite Key='IOU1' />.\n",
"<P/>\n",
"Bug reports, suggestions and comments are, of course, welcome. ",
"Please submit an issue at ",
"<URL>https://github.com/gap-packages/xmod/issues/</URL> ",
"or send an email to the first author at ",
"<Email>[email protected]</Email>. \n",
"<P/>\n"
),
Acknowledgements := Concatenation(
"This documentation was prepared using the ",
"&GAPDoc; <Cite Key='GAPDoc'/> and ",
"&AutoDoc; <Cite Key='AutoDoc'/> packages.<P/>\n",
"The procedure used to produce new releases uses the package ",
"<Package>GitHubPagesForGAP</Package> ",
"<Cite Key='GitHubPagesForGAP' /> ",
"and the package <Package>ReleaseTools</Package>.<P/>"
),
)
),

));
[![Build Status](https://github.com/gap-packages/xmod/workflows/CI/badge.svg?branch=master)](https://github.com/gap-packages/xmod/actions?query=workflow%3ACI+branch%3Amaster)
[![Code Coverage](https://codecov.io/github/gap-packages/xmod/coverage.svg?branch=master&token=)](https://codecov.io/gh/gap-packages/xmod)

# The GAP 4 package 'XMod'

## Introduction

This package allows for computation with crossed modules; cat1-groups; morphisms of these structures; derivations of crossed modules and the corresponding sections of cat1-groups.

In October 2015 a new section on isoclinism of crossed modules was added.

Functions for crossed squares and cat2-groups have been added during 2019/20.

## Distribution

* The 'XMod' package is distributed with the accepted GAP packages, see:
<https://www.gap-system.org/Packages/xmod.html>
* It may also be obtained from the GitHub repository at:
<https://gap-packages.github.io/xmod/>

## Copyright

The 'XMod' package is Copyright {\copyright} Chris Wensley et al, 1997--2024.

'XMod' is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

For details, see <http://www.gnu.org/licenses/gpl.html>

## Installation

It is assumed that you have a recent working copy of GAP, and that this contains a full set of packages in the `pkg` directory, compiled as appropriate.

XMod specifies five needed packages: utils; groupoids; HAP; AutPGrp and SmallGrp. These in turn need or suggest other packages. Some of these are loaded automatically when GAP starts.

The full list of packages which are loaded (in addition to those loaded automatically by GAP) when XMod is loaded is as follows:
* AutoDoc; Congruence; datastructures; edim; ferret; nq; polymaking; images; GRAPE; singular; Digraphs; Semigroups; groupoids; HAP and HAPcryst.

XMod does not require any compilation, but those in the list above which require compilation are as follows:
* datastructures; Digraphs; GRAPE; Semigroups and HAP.

Once these prerequisites are in place, proceed as follows:

* Unpack `xmod-<version_number>.tar.gz` in the `pkg` subdirectory of the GAP root directory.
* From within GAP load the package with:

gap> LoadPackage( "xmod" );

true

* The file manual.pdf is in the `doc' subdirectory.
* To run the test file read `testall.g` from the `tst` subdirectory.

## Contact

If you have a question relating to 'XMod', encounter any problems, or have a suggestion for extending the package in any way, please
* email: `[email protected]`
* or report an issue at: <https://github.com/gap-packages/xmod/issues/new>
Loading

0 comments on commit 5067ceb

Please sign in to comment.