Skip to content
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.

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

Documentation: Doc/several operators page #646

Merged
merged 24 commits into from
Nov 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
d0fae34
Now two Operators pages are available. Still have to add the drop-dow…
PProfizi Nov 7, 2022
6645977
Explain server contexts
PProfizi Nov 14, 2022
3699308
Merge branch 'master' into doc/several_operators_pages
PProfizi Nov 14, 2022
74ee6fd
Script used to generate both entry and premium docs
PProfizi Nov 14, 2022
93d6bdf
Link to newly generated dpf_entry.html and premium_entry.html in _static
PProfizi Nov 14, 2022
df7a1ef
Fix flake8
PProfizi Nov 15, 2022
aa08eef
Add card for the operators
Revathyvenugopal162 Nov 15, 2022
4bb7e2e
Add correct path to images
Revathyvenugopal162 Nov 15, 2022
04474d1
Apply suggestions from code review
Revathyvenugopal162 Nov 15, 2022
079ee47
Add back static html pages
PProfizi Nov 15, 2022
94cb8a2
Merge remote-tracking branch 'origin/doc/several_operators_pages' int…
PProfizi Nov 15, 2022
e4f6bef
Rework Operators landing page.
PProfizi Nov 15, 2022
61f091e
Update operator_reference.rst
PProfizi Nov 16, 2022
da6cfc8
Update text
PProfizi Nov 16, 2022
eba10ff
Update entry and premium docs
anslpa Nov 25, 2022
bea185c
Merge branch 'master' of https://github.com/pyansys/DPF-Core into doc…
anslpa Nov 25, 2022
654b32e
Some PR comments
anslpa Nov 25, 2022
3968380
Last comments
anslpa Nov 25, 2022
c8856c1
Apply suggestions from code review
PProfizi Nov 29, 2022
20674db
Apply suggestions from code review
PProfizi Nov 29, 2022
da421a6
Merge branch 'master' of https://github.com/pyansys/DPF-Core into doc…
anslpa Nov 30, 2022
91d903e
Remove images for operators
anslpa Nov 30, 2022
1f380a9
update entry and premium docs
anslpa Nov 30, 2022
0d615e3
Style check
anslpa Nov 30, 2022
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
17 changes: 17 additions & 0 deletions .ci/operator_doc_per_context.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import ansys.dpf.core as dpf
from ansys.dpf.core.server_context import \
apply_server_context, AvailableServerContexts, SERVER_CONTEXT

print(f"Server version: {dpf.global_server().version}")
# Generate entry documentation
print("Generating entry operator documentation")
print(f"Current context: {SERVER_CONTEXT}")
dpf.operators.utility.html_doc(r"../docs/source/_static/dpf_entry.html").eval()
print("Done.\n")

# Generate premium documentation
print("Generating premium operator documentation")
apply_server_context(AvailableServerContexts.premium)
print(f"Current context: {SERVER_CONTEXT}")
dpf.operators.utility.html_doc(r"../docs/source/_static/dpf_premium.html").eval()
print("Done.\n")
6 changes: 3 additions & 3 deletions ansys/dpf/core/custom_type_field.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ def __missing__(self, key):

class CustomTypeField(_FieldBase):
"""Represents a simulation data container with each unitary data being of a custom type.
When initiliazing the CustomTypeField, a unitary data type should be given.
The ``CustomTypeField`` gives the ability to choose the most optimized unitary data type
for a given usage, and hence, allows to optimize memory usage.
When initializing the ``CustomTypeField`` class, provide a unitary data type.
The ``CustomTypeField`` class gives you the ability to choose the most optimized unitary
data type for a given usage, and hence, allows you to optimize memory usage.

This can be evaluated data from the :class:`Operator <ansys.dpf.core.Operator>` class
or created directly by an instance of this class.
Expand Down
2 changes: 1 addition & 1 deletion ansys/dpf/core/elements.py
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ def mapping_id_to_index(self) -> dict:
"""
Mapping between the IDs and indices of the entity.

This proprty is useful for mapping scalar results from a field to the meshed region.
This property is useful for mapping scalar results from a field to the meshed region.

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion ansys/dpf/core/server_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ def replace_with_mounted_volumes(self, path: str) -> str:
Parameters
----------
path: str
Path to search for mounted volumes occurrences.
Path to search for occurrences of mounted volumes.

Returns
-------
Expand Down
Loading