NAME

Devel::IPerl::Plugin::EnvironmentModules - interact with Environment Modules in a Jupyter IPerl kernel

DESCRIPTION

A plugin to use when you have environment modules to work with.

The plugin is a wrapper for the Env::Modulecmd perl module.

SYNOPSIS

IPerl->load_plugin('EnvironmentModules') unless IPerl->can('module_load');
IPerl->module_load('git');
IPerl->module_unload('git');

INSTALLATION AND REQUISITES

IPerl Interface Method

register

Called by IPerl->load_plugin('EnvironmentModules').

REGISTERED METHODS

module_avail

IPerl->module_list;

Display a list of environment modules that are available.

module_list

IPerl->module_list;

Display the list of environment modules that are loaded.

module_list_array

my $loaded = IPerl->module_list_array;

Return an array reference to the list of loaded modules as returned by "module_list".

module_load

IPerl->module_load('gcc');

Load a list of environment modules.

module_search

IPerl->module_search(qr/gcc/);
IPerl->module_search('gcc');

Display a list of matching modules. The query can either be a regular expression or a literal string.

module_show

IPerl->module_show('gcc');

Display the environment modified by the given environment module.

module_unload

IPerl->module_unload('gcc');

Unload a list of environment modules.

INTERNAL METHODS

Not for end user consumption.

avail

my $p = Devel::IPerl::Plugin::EnvironmentModules->new();
$p->avail;

A more longwinded IPerl->module_avail;.

list

my $p = Devel::IPerl::Plugin::EnvironmentModules->new();
$p->list();

A more longwinded IPerl->module_list;.

list_array

my $p = Devel::IPerl::Plugin::EnvironmentModules->new();
$p->list_array();

A more longwinded IPerl->module_list_array;.

load

my $p = Devel::IPerl::Plugin::EnvironmentModules->new();
$p->load('gcc');

A more longwinded IPerl->module_load;.

new

my $p = Devel::IPerl::Plugin::EnvironmentModules->new();

Create a new instance.

search

my $p = Devel::IPerl::Plugin::EnvironmentModules->new();
$p->search(qr/gcc/);
$p->search('gcc');

show

my $p = Devel::IPerl::Plugin::EnvironmentModules->new();
$p->show('gcc');

A more longwinded IPerl->module_show;.

unload

my $p = Devel::IPerl::Plugin::EnvironmentModules->new();
$p->unload('gcc');

A more longwinded IPerl->module_unload;.

SEE ALSO

Env::Modulecmd

Devel::IPerl