|
1 | 1 | Welcome to NRM's documentation!
|
2 | 2 | ===============================
|
3 | 3 |
|
4 |
| -If you know about NRM and are just looking to get it to run on your |
5 |
| -application, please visit the :doc:`quickstart <quickstart>` guide. |
| 4 | +.. meta:: |
| 5 | + :http-equiv=Refresh: 0; url='https://libnrm.readthedocs.io/en/latest/' |
6 | 6 |
|
7 |
| -This documentation is technical. For a high-level overview of NRM, please |
8 |
| -refer to the Argo website_. |
9 |
| - |
10 |
| -The Node Resource Manager (NRM) is a node-local userspace client-server daemon |
11 |
| -for managing your scientific applications. It runs the various tasks that |
12 |
| -compose an application in resource-constrained slices, monitors |
13 |
| -performance, power use and application progress, and arbitrates resources at |
14 |
| -the node level, along with CPU Cores, NUMA Nodes, and Power budgets. |
15 |
| - |
16 |
| -There are two user software components shipped with NRM itself: the ``nrm`` |
17 |
| -command-line client and the ``nrmd`` daemon. Additionally, NRM ships with the |
18 |
| -``libnrm`` application instrumentation library, to be used for progress |
19 |
| -monitoring. The following diagram describes this architecture: |
20 |
| - |
21 |
| - .. image:: nrm.svg |
22 |
| - |
23 |
| -Note that the container runtime used by NRM to allocate slices is a |
24 |
| -system-installed dependency, regardless of whether Argo NodeOS or Singularity is used. |
25 |
| - |
26 |
| -The :doc:`quickstart <quickstart>` guide describes the use of ``nrm`` and ``nrmd``. |
27 |
| -Please refer to the ``libnrm`` guide for application |
28 |
| -instrumentation. See the `haddock`_ documentation for the shared library API, |
29 |
| -and the notebooks under :doc:`NRM-Python<nrm-python:index>` for python upstream client use. |
30 |
| - |
31 |
| -.. toctree:: |
32 |
| - :maxdepth: 2 |
33 |
| - :caption: User Guides: |
34 |
| - |
35 |
| - quickstart |
36 |
| - config |
37 |
| - |
38 |
| -.. toctree:: |
39 |
| - :maxdepth: 2 |
40 |
| - :caption: Instrumentation: |
41 |
| - |
42 |
| - libnrm (C/C++ and Fortran API) <https://nrm.readthedocs.io/projects/libnrm/en/master/> |
43 |
| - NRM-Python <https://nrm.readthedocs.io/projects/nrm-python/en/master/> |
44 |
| - |
45 |
| -.. toctree:: |
46 |
| - :maxdepth: 2 |
47 |
| - :caption: Internal: |
48 |
| - |
49 |
| - NRM-Core <https://nrm.readthedocs.io/projects/nrm-core/en/master/> |
50 |
| - |
51 |
| - |
52 |
| -Indices and tables |
53 |
| -================== |
54 |
| - |
55 |
| -* :ref:`search` |
56 |
| - |
57 |
| -.. _website: https://www.mcs.anl.gov/research/projects/argo/overview/nrm/ |
58 |
| -.. _haddock: http://hnrm.readthedocs.io/en/latest/_static/haddocks |
| 7 | +This project has been moved, if you aren't redirected automatically |
| 8 | +go to https://libnrm.readthedocs.io/en/latest/. |
0 commit comments