Documentation: Add ServerContext, ServerConfiguration and GettingStartedWithDPFServer sections #637
Conversation
Codecov Report
@@ Coverage Diff @@
## master #637 +/- ##
==========================================
- Coverage 88.11% 88.06% -0.06%
==========================================
Files 69 69
Lines 7750 7756 +6
==========================================
+ Hits 6829 6830 +1
- Misses 921 926 +5 |
…into doc/contexts # Conflicts: # docs/source/user_guide/dpf_concepts.rst
This reverts commit 41406bf.
Co-authored-by: JennaPaikowsky <[email protected]>
| Running the DPF Server | ||
| ~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| On Windows, start the DPF Server by running the Ans.Dpf.Grpc.bat file in the unzipped package. |
There was a problem hiding this comment.
@anslpa I would rather specify the batch and bash files at the end because user should not have to do it.
We could instead explain that the first entity created will start on (give a Field example maybe) and show the start_local_server snippet?
|
|
||
| DPF capabilities are available through the following main services: | ||
| - Entry: Loads the minimum number of plugins for basic use. It is the default. It will only check if an Ansys License is available. | ||
| - Premium: Uses the premium DataProcessingCore.xml file to load most plugins.... with their environments. It will checkout a license. |
There was a problem hiding this comment.
@PProfizi I took that comment into account.
| default capabilities a server will be started with. | ||
|
|
||
| The server context is composed of the following information: | ||
| - context_type, :class:`LicensingContextType <ansys.dpf.core.server_context>` |
There was a problem hiding this comment.
you have the same link for AvailableServerContexts and LicensingContextType?
There was a problem hiding this comment.
@cbellot000 the link is to the module in which the class is, isn't it?
| Getting started with Entry capabilities | ||
| --------------------------------------- | ||
|
|
||
| Find the list of operators available when the context is Entry at :ref:`ref_dpf_operators_reference`. |
There was a problem hiding this comment.
to coordinate with @PProfizi
There was a problem hiding this comment.
It should be fine, I did not change the reference name
| Terminology | ||
| ----------- | ||
|
|
||
| DPF is based on a **client-server** architecture. It allows **local** or **remote** |
There was a problem hiding this comment.
In the getting started section, I went for communication "in process" or "through the network" to be closer to the truth. We can use either one or the other but should be consistent maybe
There was a problem hiding this comment.
@PProfizi I took that comment into account, and the discussion we had yesterday; we can discuss it if needed.
Co-authored-by: PProfizi <[email protected]>
Co-authored-by: PProfizi <[email protected]>
Co-authored-by: PProfizi <[email protected]>
Co-authored-by: PProfizi <[email protected]>
…to doc/contexts
In the User Guide, 3 sections have been added: