Modules: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
(Refactoring this page)
No edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages />
<languages />
<translate>
<translate>
In the context of computer software, a ''module'' is a way for a user to access the functionality of a particular piece of software. That being defined, this page briefly describes a few types of software modules and cites their corresponding documentation pages.


== ''Module'' Disambiguation ==
<!--T:1-->
In computing, a module is a unit of software that is designed to be independent, interchangeable, and contains everything necessary to provide the desired functionality.
<ref>[https://en.wikipedia.org/wiki/Modular_programming Wikipedia, "Modular programming"]</ref>
The term "module" may sometimes have a more specific meaning depending on the context.
This page describes a few types of modules and suggests links to further documentation content.


=== Lmod Modules ===
== Disambiguation == <!--T:2-->
Lmod modules are used to alter a user's (shell) environment, in a way that is relatively easy to manage, both for the user and for the person that has installed the software in question. A complete introduction to ''modules'' and ''module files'' is presented in the [[Using modules]] page.


Note: it is also possible for users to [[Utiliser_des_modules/en#Creating_modules|create their own modules]].
=== Lmod modules === <!--T:3-->


=== Python Modules ===
<!--T:4-->
Python modules are imported in Python scripts in order to import additional classes and functions to these Python scripts. Users can install Python modules in a [[Python#Creating_and_using_a_virtual_environment|Python virtual environment]] from a collection of [[Python#Available_wheels|available Python wheels]], which are precompiled modules compatible with the [[Standard software environments]].
Also called "environment modules", Lmod modules are used to alter your (shell) environment so as to enable you to use a particular software package,
or to use a non-default version of certain common software packages such as compilers.  See [[Using modules]].


Otherwise, users can use a <code>python</code> Lmod module along with a <code>scipy-stack</code> Lmod module in order to run their Python scripts. Note: the [[Python#SciPy_stack|SciPy stack]] is only a small collection of preinstalled scientific Python modules.
=== Python modules === <!--T:5-->


== Other ''Module'' Related Topics ==
<!--T:6-->
The main [[Available software]] page is a good starting point. Other related pages:
In Python, a module is a file of code (usually Python code) which can be loaded with the <code>import ...</code> or <code>from ... import ...</code> statements to provide functionality.  A Python package is a collection of Python modules; the terms "package" and "module" are frequently interchanged in casual use.
* [[Standard software environments]]: as of April 1st, 2021, <code>StdEnv/2020</code> is the default collection of Lmod modules
<ref>[https://www.tutorialspoint.com/What-is-the-difference-between-a-python-module-and-a-python-package Tutorialspoint.com, "What is the difference between a python module and a python package?"]</ref>
* [[Modules specific to Niagara]]
 
* Tables of modules optimized for [[Modules avx|AVX]], '''[[Modules avx2|AVX2]]''' and '''[[Modules avx512|AVX512]]''' [[Standard_software_environments#Performance_improvements|CPU instructions]]
<!--T:7-->
Certain frequently used Python modules such as Numpy can be imported if you first load the <code>scipy-stack</code> Lmod module at the shell level.
See [[Python#SciPy_stack|SciPy stack]] for details.
 
<!--T:8-->
We maintain a large collection of [[Python#Available_wheels|Python "wheels."]]
These are modules which are pre-compiled to be compatible with the [[Standard software environments]].
Before importing modules from our wheels, you should create a [[Python#Creating_and_using_a_virtual_environment|virtual environment]]. 
 
<!--T:9-->
Python modules which are not in the <code>scipy-stack</code> Lmod module or in our wheels collection can be installed from the internet
as described in the [[Python#Installing_packages|Installing packages]] section.
 
== Other related topics == <!--T:10-->
 
<!--T:11-->
The main [[Available software]] page is a good starting point. Other related pages are:
* [[Standard software environments]]: as of April 1, 2021, <code>StdEnv/2020</code> is the default collection of Lmod modules
* Lmod [[modules specific to Niagara]]
* Tables of Lmod modules optimized for [[Modules avx|AVX]], '''[[Modules avx2|AVX2]]''' and '''[[Modules avx512|AVX512]]''' [[Standard_software_environments#Performance_improvements|CPU instructions]]
* [[:Category:Software|Category ''Software'']]: a list of different software pages in this wiki, including commercial or licensed software
* [[:Category:Software|Category ''Software'']]: a list of different software pages in this wiki, including commercial or licensed software
== Footnotes == <!--T:12-->
</translate>
</translate>

Latest revision as of 01:32, 22 June 2022

Other languages:

In computing, a module is a unit of software that is designed to be independent, interchangeable, and contains everything necessary to provide the desired functionality. [1] The term "module" may sometimes have a more specific meaning depending on the context. This page describes a few types of modules and suggests links to further documentation content.

Disambiguation

Lmod modules

Also called "environment modules", Lmod modules are used to alter your (shell) environment so as to enable you to use a particular software package, or to use a non-default version of certain common software packages such as compilers. See Using modules.

Python modules

In Python, a module is a file of code (usually Python code) which can be loaded with the import ... or from ... import ... statements to provide functionality. A Python package is a collection of Python modules; the terms "package" and "module" are frequently interchanged in casual use. [2]

Certain frequently used Python modules such as Numpy can be imported if you first load the scipy-stack Lmod module at the shell level. See SciPy stack for details.

We maintain a large collection of Python "wheels." These are modules which are pre-compiled to be compatible with the Standard software environments. Before importing modules from our wheels, you should create a virtual environment.

Python modules which are not in the scipy-stack Lmod module or in our wheels collection can be installed from the internet as described in the Installing packages section.

Other related topics

The main Available software page is a good starting point. Other related pages are:

Footnotes