Modules: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 6: Line 6:
<ref>[https://en.wikipedia.org/wiki/Modular_programming Wikipedia, "Modular programming"]</ref>
<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.
The term "module" may sometimes have a more specific meaning depending on the context.
This page describes a few types of modules with their corresponding documentation pages.  
This page describes a few types of modules and suggests links to further documentation content.  


== Disambiguation == <!--T:2-->
== Disambiguation == <!--T:2-->
Line 23: Line 23:


<!--T:7-->
<!--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.
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.
See [[Python#SciPy_stack|SciPy stack]] for details.


<!--T:8-->
<!--T:8-->
We maintain a large collection of [[Python#Available_wheels|Python "wheels"]].
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]].
These are modules which are pre-compiled to be compatible with the [[Standard software environments]].
Before importing modules from the our wheels, you should create a [[Python#Creating_and_using_a_virtual_environment|virtual environment]].   
Before importing modules from our wheels, you should create a [[Python#Creating_and_using_a_virtual_environment|virtual environment]].   


<!--T:9-->
<!--T:9-->
Python modules which are in neither the <code>scipy-stack</code> Lmod module nor in our wheels collection can be installed from the internet
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 at [[Python#Installing_packages|the Installing packages section]].
as described in the [[Python#Installing_packages|Installing packages]] section.


== Other related topics == <!--T:10-->
== Other related topics == <!--T:10-->


<!--T:11-->
<!--T:11-->
The main [[Available software]] page is a good starting point. Other related pages:
The main [[Available software]] page is a good starting point. Other related pages are:
* [[Standard software environments]]: as of April 1st, 2021, <code>StdEnv/2020</code> is the default collection of Lmod modules
* [[Standard software environments]]: as of April 1, 2021, <code>StdEnv/2020</code> is the default collection of Lmod modules
* Lmod [[modules specific to Niagara]]
* 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]]
* Tables of Lmod modules optimized for [[Modules avx|AVX]], '''[[Modules avx2|AVX2]]''' and '''[[Modules avx512|AVX512]]''' [[Standard_software_environments#Performance_improvements|CPU instructions]]

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