#
# Gurobify: Gurobify provides an interface to Gurobi from ⪆.
#
# This file contains package meta data. For additional information on
# the meaning and correct usage of these fields, please consult the
# manual of the "Example" package as well as the comments in its
# PackageInfo.g file.
#
SetPackageInfo( rec(

PackageName := "Gurobify",
Subtitle := "A GAP interface to Gurobi Optimizer.",
Version := "2.0.0",
Date := "24/06/2021", # dd/mm/yyyy format

Persons := [
  rec(
    IsAuthor := true,
    IsMaintainer := true,
    FirstNames := "Jesse",
    LastName := "Lansdown",
    WWWHome := "https://www.jesselansdown.com",
    Email := "jesse.lansdown@uwa.edu.au",
    PostalAddress := Concatenation(
               "Jesse Lansdown\n",
               "Centre for the Mathematics of Symmetry and Computation\n",
               "The University of Western Australia\n",
               "35 Stirling Highway\n",
               "PERTH WA 6009\n",
               "Australia" ),
    Place := "Perth",
    Institution := "The University of Western Australia",
  ),
],

#SupportEmail := "TODO",


SourceRepository := rec(
    Type := "git",
    URL := Concatenation( "https://github.com/jesselansdown/", ~.PackageName ),
),

IssueTrackerURL := Concatenation( ~.SourceRepository.URL, "/issues" ),
PackageWWWHome  := Concatenation( "https://www.jesselansdown.com/", ~.PackageName ),
README_URL      := Concatenation( ~.PackageWWWHome, "/README.md" ),
PackageInfoURL  := Concatenation( ~.PackageWWWHome, "/PackageInfo.g" ),
ArchiveURL      := Concatenation( ~.SourceRepository.URL,
                                 "/releases/download/v", ~.Version,
                                 "/", ~.PackageName, "-", ~.Version ),


ArchiveFormats := ".tar.gz",

##  Status information. Currently the following cases are recognized:
##    "accepted"      for successfully refereed packages
##    "submitted"     for packages submitted for the refereeing
##    "deposited"     for packages for which the GAP developers agreed
##                    to distribute them with the core GAP system
##    "dev"           for development versions of packages
##    "other"         for all other packages
##
Status := "dev",

AbstractHTML   :=  "",

PackageDoc := rec(
  BookName  := "Gurobify",
  ArchiveURLSubset := ["doc"],
  HTMLStart := "doc/chap0.html",
  PDFFile   := "doc/manual.pdf",
  SixFile   := "doc/manual.six",
  LongTitle := "Gurobify provides an interface to Gurobi Optimizer from GAP.",
),

Dependencies := rec(
  GAP := ">= 4.8",
  NeededOtherPackages := [  ],
  SuggestedOtherPackages := [ [ "GAPDoc", ">= 1.6.4" ] ],
  ExternalConditions := [ "Gurobi", "=7.0" ],
),

AvailabilityTest := function()
        return true;
    end,

TestFile := "tst/testall.g",

#Keywords := [ "TODO" ],

AutoDoc := rec(
    TitlePage := rec(
        Copyright := Concatenation("&copyright; 2017 - 2021 Jesse Lansdown<P/>\n\n",
                    "Gurobify is subject to the terms of the Mozilla ",
                    "Public License, v. 2.0. If a copy of the MPL was not distributed ",
                    "with this file, You can obtain one at https://mozilla.org/MPL/2.0/.\n"),
        Abstract := Concatenation("Gurobify provides an interface to the Gurobi Optimizer software from &GAP;. ",
          "It enables the creation and modification of mixed integer and linear programming models which can be solved directly ",
          "by Gurobi from within the &GAP; environment."),
        Acknowledgements := Concatenation("I thank Sebastian Gutsche for generously taking the time ",
          "to explain the inner workings of &GAP; and &GAP; packages to me, and for pointing me towards examples. ",
          "I also thank John Bamberg for introducing me to both &GAP; and Gurobi ",
          "and showing me how they can be used to so effectively complement each other. ",
          "I used the AutoDoc<Cite Key=\"autodoc\"/> package to streamline ",
          "the creation of the documentation for this package, ",
          "and PackageMaker<Cite Key=\"packagemaker\"/> to generate a package template. ",
           "I would also like to acknowledge the support of an Australian Government Research Training Program (RTP) Scholarship ",
           "while writing this software.")
    )
),


));