Skip to content

Commit

Permalink
update installation docs to use pip now that package is uploaded to pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
shahzebsiddiqui committed Mar 25, 2020
1 parent 4f8c4e5 commit 73aff8b
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,18 @@ You will need the following to use ``lmodule``.
- Python 3.6 or higher
- Lmod 7 or higher

Setup

PyPI Installation
--------------------

You can install lmdoule via pip as follows::

pip install lmodule

Git
-------

If you have not done so, clone the repository as follows::
If you prefer to use the latest codebase you can clone the repository as follows::

$ git clone https://github.com/HPC-buildtest/lmodule.git

Expand All @@ -25,3 +33,13 @@ Next you will want to install lmodule in your python environment::
$ python3 setup.py install


Validation
-----------

If you are able to install lmodule in your python environment, you can test it as follows::


$ python -c "from lmod.module import Module; print(Module().version())"
7.8.16

The above command will import the Module class and return the Lmod version in your system.

0 comments on commit 73aff8b

Please sign in to comment.