Skip to main content

Jülich Monitoring and Control

Project description

Installation | Execution | Authorization | Further documentation | Getting help |

JuMonC

JuMonC stands for "Jülich monitoring and control" and allows easier access to monitor running simulations and provides data using a REST-API.


Installation

JuMonC can be installed using pip:

pip install JuMonC

This also creates an entry point, allowing to start JuMonC with just the command JuMonC

Runtime dependencies

Optional runtime dependencies

Execution

JuMonC needs to be started parallel to your running simulation and needs one mpi process on each node your simulation is using. The actual REST-API will only be avaiable on node 0 and then communicate internaly using mpi.

It can be started by running srun -n <#nodes> --ntasks-per-node=1 JuMonC &

By default, this will start the REST-API on port 12121 on rank 0 of this allocation. The port can be changed by providing -p=<port>. Depending on the firewall rules of the system you are using, it might be necessary to use a ssh-tunnel to forward this endpoint of the API to somewhere else where you can access it.

Authorization

Security is always a concern, and to block unauthorized access of this API there is a scope based token authorization included. This means each action requires authorization, with different tokens having a different scope of allowed actions. The tokens included by default and printed to stdout on startup are hierarchical, therefore every token includes the authorized functions of all lower tokens:

  1. see_links
  2. retrieve_data
  3. compute_data
  4. retrieve_simulation_data
  5. compute_simulation_data
  6. full

There are two options to prove your authorization, either cookie based by providing the token once in the login function (e.g. /login?token=12345678) or providing it by every API call as an additional parameter (e.g. /v1/network?token=12345678).

Further documentation

Getting help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

JuMonC-0.5.0.tar.gz (22.8 kB view hashes)

Uploaded Source

Built Distribution

JuMonC-0.5.0-py3-none-any.whl (40.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page