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
Runtime dependencies
- python3
- mpi4py
- flask
- flask-login
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 python3 app.py &
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:
- see_links
- retrieve_data
- compute_data
- retrieve_simulation_data
- compute_simulation_data
- 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
- REST-API
- Possible cmd arguments or using the
-h
flag
Getting help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for JuMonC-0.4.0rc0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 111d6721759265b22ce5cd057f942151324eb9019f3e972b8b219d15feea9f76 |
|
MD5 | f36ca80175b2892cf4ab1cb0daa490b6 |
|
BLAKE2b-256 | a65f72a526a110093754addc0f2782799796693c038ba977a0bc493508f2a130 |