Skip to content

Add licensing tutorial "Access entry and premium capabilities" #1877

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

Closed
wants to merge 3 commits into from
Closed

Add licensing tutorial "Access entry and premium capabilities" #1877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
56fc465
move "access entry and premium capabilities" (how-to) to the licensin…
luisaFelixSalles Nov 7, 2024
16ee344
changes in the card text
luisaFelixSalles Nov 7, 2024
e1d170a
use the jupyter sphinx extension
luisaFelixSalles Nov 7, 2024
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
7 changes: 0 additions & 7 deletions doc/source/user_guide/how_to.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,6 @@ How-tos
:text-align: center

.. image:: ../images/drawings/remote_machines.png

.. grid-item-card:: Access Entry and Premium capabilities
:link: user_guide_server_context
:link-type: ref
:text-align: center

.. image:: ../images/drawings/entry_premium.png


.. grid-item-card:: Use DPF XML Files
Expand Down
1 change: 0 additions & 1 deletion doc/source/user_guide/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ Troubleshooting
custom_operators.rst
dpf_server.rst
server_types.rst
server_context.rst
xmlfiles.rst


Expand Down
6 changes: 4 additions & 2 deletions doc/source/user_guide/tutorials/11-licensing/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@ Licensing
:margin: 2

.. grid-item-card:: Access Entry and Premium Capabilities
:link: ref_tutorials
:link: user_guide_server_context
:link-type: ref
:text-align: center

This tutorial
This tutorial explains the DPF server licensing logic

.. toctree::
:maxdepth: 2
:hidden:

Access Entry and Premium Capabilities <server_context.rst>

30 changes: 21 additions & 9 deletions doc/source/user_guide/server_context.rst → ...tutorials/11-licensing/server_context.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,15 @@ Once a DPF Server is started in **Entry** context, it can be upgraded to the

.. rst-class:: sphx-glr-script-out

.. code-block:: none

Server Context of type LicensingContextType.entry with no xml path
.. jupyter-execute::
:hide-code:

from ansys.dpf import core as dpf
# start a server with entry capabilities
server = dpf.start_local_server(
context=dpf.AvailableServerContexts.entry
)
print(server.context)

.. code-block::

Expand All @@ -56,9 +62,12 @@ Once a DPF Server is started in **Entry** context, it can be upgraded to the

.. rst-class:: sphx-glr-script-out

.. code-block:: none

Server Context of type LicensingContextType.premium with no xml path
.. jupyter-execute::
:hide-code:

# apply a premium context on the server
server.apply_context(dpf.AvailableServerContexts.premium)
print(server.context)


Change the default server context
Expand All @@ -77,9 +86,12 @@ with this code:

.. rst-class:: sphx-glr-script-out

.. code-block:: none

Server Context of type LicensingContextType.entry with no xml path
.. jupyter-execute::
:hide-code:

from ansys.dpf import core as dpf
dpf.set_default_server_context(dpf.AvailableServerContexts.entry)
print(dpf.server_context.SERVER_CONTEXT)

.. warning::
As starting an ``InProcess`` server means linking the DPF binaries to your current Python
Expand Down
Loading