Skip to content

Commit

Permalink
Added images folder
Browse files Browse the repository at this point in the history
  • Loading branch information
vcalderon2009 committed Apr 18, 2018
1 parent e3ce677 commit 4038459
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 6 deletions.
Binary file added docs/source/images/useful_tools/htop_bottom.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/useful_tools/htop_top.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 60 additions & 6 deletions docs/source/useful_tools.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
.. _useful_tools:
=====================================
*********************************
Tools you might want to check out
=====================================
*********************************

.. contents:: Table of Contents
:local:

.. _tools_intro:
----------------------
============
Introduction
----------------------
============

There are tools out there that can make your workflow **much, much smoother**.
This is a small list of some of the tools that I've found useful throughout my
stay at Vanderbilt. They have significantly improved my workflow, and
have made the projects much easier to understand.

.. _htop_sec:
--------------------------------------
=====================================
htop - An interactive viewer for Unix
--------------------------------------
=====================================

For viewing which processes are running on your computer and how much
memory is left, I like to use `htop <https://hisham.hm/htop/>`_.
Expand All @@ -33,6 +33,60 @@ This application, as shown in
htop running in the terminal.
Credit: `Wikipedia <https://en.wikipedia.org/wiki/Htop#/media/File:Htop.png>`_

This tools is extremely useful when running multiple jobs, since it lets
you see which *jobs* are running, for how long they've been running, and
more. Figure :numref:`htop_fig` how *htop* looks whenever you run this
from the terminal:

.. code-block:: shell
htop
.. _htop_explained:
--------------
htop Explained
--------------

htop has different things to offer. Figures :numref:`htop_top_fig` and
:numref:`htop_bottom_fig` explain what each column means.

.. _label: htop_top_fig
.. figure:: ./images/useful_tools/htop_top.png

Top of *htop*. This figure shows the different components in the
upper part of *htop*.
Credit: `CodeAhoy<https://codeahoy.com>`_

And the bottom part ...

.. _label: htop_bottom_fig
.. figure:: ./images/useful_tools/htop_bottom.png

Top of *htop*. This figure shows the different components in the
bottom part of *htop*.
Credit: `CodeAhoy<https://codeahoy.com>`_


.. _htop_resources:
---------------
Further Reading
---------------

For a **more in depth discussion** of the different sections of :code:`htop`,
see:

* `htop Explained Visually <https://codeahoy.com/2017/01/20/hhtop-explained-visually/>`_
* `Understanding and using htop monitor system resources <http://www.deonsworld.co.za/2012/12/20/understanding-and-using-htop-monitor-system-resources/>`_
* `htop Explained <https://peteris.rocks/blog/htop/>`_

.. _tmux_screen_sec:
=============================================
tmux and screen - Terminal Multiplexers
=============================================







Expand Down

0 comments on commit 4038459

Please sign in to comment.