Skip to content

Add missing RMS api doc file #250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 1, 2023
Merged

Add missing RMS api doc file #250

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions doc/source/api/rms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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