From a6eae7ef4fc950873d0bd1dfd2029e827598f879 Mon Sep 17 00:00:00 2001 From: Federico Negri Date: Fri, 1 Dec 2023 07:26:29 +0100 Subject: [PATCH] Add missing rms doc file --- doc/source/api/rms.rst | 44 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 doc/source/api/rms.rst diff --git a/doc/source/api/rms.rst b/doc/source/api/rms.rst new file mode 100644 index 000000000..f8582036c --- /dev/null +++ b/doc/source/api/rms.rst @@ -0,0 +1,44 @@ +Resource Management Service +=========================== + +Ansys REP includes the Resource Management Service (JMS), which is the main service for managing heterogeneous compute resources. + +The Python subpackage ``ansys.rep.client.rms`` wraps around the RMS service REST API available at ``https://hostname:port/rep/rms/api``. + +APIs +-------------------------------------- + +RMS Api +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. autoclass:: ansys.rep.client.rms.RmsApi + :members: + :undoc-members: + + +Resources +-------------------------------------- + +Evaluator Registration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autopydantic_model:: ansys.rep.client.rms.EvaluatorRegistration + +Evaluator Configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autopydantic_model:: ansys.rep.client.rms.EvaluatorConfiguration + +Evaluator Configuration Update +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autopydantic_model:: ansys.rep.client.rms.EvaluatorConfigurationUpdate + +Scaler Configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autopydantic_model:: ansys.rep.client.rms.ScalerRegistration + +Compute Resource Set +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autopydantic_model:: ansys.rep.client.rms.ComputeResourceSet