Skip to content

Commit 90d6867

Browse files
committed
Added instructions for building, installing, and running hostlist on local machine
1 parent 820eeed commit 90d6867

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/index.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,26 @@ py-hostlist
88

99
py-hostlist processes slurm-style hostlist strings and can return those strings in manipulated fashion.
1010

11-
Get py-hostlist from the `github repository <https://github.com/LLNL/py-hostlist>`_ and start using it!
11+
Get py-hostlist from the `github repository <https://github.com/LLNL/py-hostlist>`_:
1212

1313
.. code-block:: console
1414
1515
$ git clone https://github.com/llnl/py-hostlist.git
1616
$ cd py-hostlist
1717
18+
From here, build and install the package on your machine:
19+
20+
.. code-block:: console
21+
22+
$ python setup.py sdist bdist_wheel
23+
$ pip install dist/py_hostlist-0.0.1.dev0-py2.py3-none-any.whl
24+
25+
Now you can start using it!
26+
27+
.. code-block:: console
28+
29+
$ hostlist -h
30+
1831
.. toctree::
1932
:maxdepth: 2
2033
:caption: Basics

0 commit comments

Comments
 (0)