loadPackage -- load a package

Synopsis

• Usage:

  loadPackage "PACKAGENAME"

• Inputs:
  • PACKAGENAME, a string, the name of the package
• Optional inputs:
  • FileName => a string, default value null, the name of the file containing the source code of the package, from which it should be loaded
  • LoadDocumentation => a Boolean value, default value false, whether to load the documentation of the package, too; see beginDocumentation
  • DebuggingMode => a Boolean value, default value null, the value of debuggingMode during loading the package; specifying it here overrides the value specified as an option to newPackage by the package itself; however, if debuggingMode is already false, it will remain so.
  • Configuration => a list, default value {}, a list of options KEY => VALUE, overriding the defaults specified in the source code of the package and the (possibly updated) values in the file in the user's application directory.
  • Reload => a Boolean value, default value null, whether to reload the package, if it has been loaded before
• Outputs:
  • a package, the package just loaded.
• Consequences:

  • Loads the package PACKAGENAME that is in the file PACKAGENAME.m2

Description

The file PACKAGENAME.m2 should be on the load path and should contain a package named PACKAGENAME.

If the variable notify is set to true, then an informational message is displayed after the file is loaded.

i1 : notify = true

o1 = true

i2 : loadPackage "FirstPackage"
--opening database /usr/lib/Macaulay2/FirstPackage/cache/rawdocumentation-dcba-8.db
--beginDocumentation: using documentation database, skipping the rest of /usr/share/Macaulay2/FirstPackage.m2
--package "FirstPackage" loaded
--loaded /usr/share/Macaulay2/FirstPackage.m2

o2 = FirstPackage

o2 : Package

See also

• packages
• an example of a package
• needsPackage -- load a package if not already loaded
• load -- read Macaulay2 commands