diff --git a/docs/howto/nbresuse.rst b/docs/howto/nbresuse.rst new file mode 100644 index 0000000..616146d --- /dev/null +++ b/docs/howto/nbresuse.rst @@ -0,0 +1,15 @@ +.. _howto/nbresuse: + +======================= +Check your memory usage +======================= + +The `nbresuse `_ extension is part of +the default installation, and tells you how much memory your user is using +right now, and what the memory limit for your user is. It is shown in the +top right corner of the notebook interface. Note that this is memory usage +for everything your user is running through the Jupyter notebook interface, +not just the specific notebook it is shown on. + +.. image:: ../images/nbresuse.png + :alt: Memory limit / usage shown with nbresuse diff --git a/docs/howto/resource-estimation.rst b/docs/howto/resource-estimation.rst index cc21d46..d503196 100644 --- a/docs/howto/resource-estimation.rst +++ b/docs/howto/resource-estimation.rst @@ -40,16 +40,14 @@ Maximum memory allowed per user Depending on what kinda work your users are doing, they will use different amounts of memory. The easiest way to determine this is to run through a typical user -workflow yourself, and measure how much memory is used. +workflow yourself, and measure how much memory is used. You can use :ref:`howto/nbresuse` +to determine how much memory your user is using. -For example, you can begin running a Jupyter Notebook session on your JupyterHub, then open a -terminal on the JupyterHub and use ``top`` to track how much memory you use -as you go through the material. A good rule of thumb is to take the maximum amount of memory you used during +A good rule of thumb is to take the maximum amount of memory you used during your session, and add 20-40% headroom for users to 'play around'. This is the maximum amount of memory that should be given to each user. -If users use *more* than this alloted amount of memory, their kernel will restart (and all -their progress in the current session will be lost). +If users use *more* than this alloted amount of memory, their notebook kernel will restart. CPU === diff --git a/docs/images/nbresuse.png b/docs/images/nbresuse.png new file mode 100644 index 0000000..75a4644 Binary files /dev/null and b/docs/images/nbresuse.png differ diff --git a/docs/index.rst b/docs/index.rst index 9ff8929..eaf5931 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -61,6 +61,7 @@ How-To guides answer the question 'How do I...?' for a lot of topics. howto/share-data howto/notebook-interfaces howto/resource-estimation + howto/nbresuse Authentication --------------