Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions doc/changelog.d/980.documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update fileio.rst
28 changes: 18 additions & 10 deletions doc/source/user_guide/fileio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
.. code-block:: python

params = prime.ImportCadParams(
model=model, cad_reader_route=prime.CadReaderRoute.SPACECLAIM
model=model, cad_reader_route=prime.CadReaderRoute.DISCOVERY
)
prime.FileIO(model).import_cad(file_name=mixing_elbow, params=params)

Expand All @@ -66,9 +66,9 @@
.. code-block:: python

mesh_util = prime.lucid.Mesh(model=model)
mesh_util.read(file_name=mixing_elbow, cad_reader_route=prime.CadReaderRoute.SPACECLAIM)
mesh_util.read(file_name=mixing_elbow, cad_reader_route=prime.CadReaderRoute.DISCOVERY)

Four CAD import routes are available in PyPrimeMesh:
Five CAD import routes are available in PyPrimeMesh:

* ``Program controlled``: Chooses the CAD reader route based on the extension of the provided CAD file as follows:

Expand All @@ -88,17 +88,25 @@
Ensure to install Discovery for Discovery reader.

* ``Workbench``: Uses Workbench to import supported CAD files from the Workbench reader.
Ensure to install Workbench for Workbench reader.
Ensure to install Workbench for Workbench reader.

.. note:
* When you import CAD using the SpaceClaim or Discovery reader routes the user import options in those applications are ignored.

* If the options are required then you can import CAD in the application stand-alone with the options defined and export it to a native format (FMD or PMDB) to import into Ansys Prime Server.

To view the CAD files supported for the Workbench route on different platforms, see
`CAD Support <https://www.ansys.com/it-solutions/platform-support>`_ on the Ansys website.

.. note::
* Program controlled supports faceted data. Workbench supports BRep geometry(non-faceted) data.
Discovery or SpaceClaim supports both BRep geometry and faceted data.

* When deploying scripts using SpaceClaim, Discovery, or Workbench CAD reader routes, ensure that the CAD configuration
and in-app defaults are consistent in the deployed environment.
* When deploying scripts using the Workbench CAD reader route, ensure that the user options for the installed
application are consistent in the deployed environment.

Check warning on line 106 in doc/source/user_guide/fileio.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/user_guide/fileio.rst#L106

[Google.WordList] Use 'app' instead of 'application'.
Raw output
{"message": "[Google.WordList] Use 'app' instead of 'application'.", "location": {"path": "doc/source/user_guide/fileio.rst", "range": {"start": {"line": 106, "column": 7}}}, "severity": "WARNING"}

* When deploying scripts using the CAD configuration, ensure that the configuration is consistent in the deployed
environment.

* You must install and configure Workbench CAD readers or plug-ins (Ansys Geometry Interfaces)
while installing Ansys Workbench.
Expand All @@ -120,15 +128,15 @@
.. code-block:: python

params = prime.ImportCadParams(model=model, append=True)
prime.FileIO(model).import_cad(file_name="cad_to_append.scdoc", params=params)
prime.FileIO(model).import_cad(file_name="cad_to_append.dsco", params=params)

Alternatively, you can use the :class:`Mesh <ansys.meshing.prime.lucid.Mesh>` class in
the Lucid API:

.. code-block:: python

mesh_util = prime.lucid.Mesh(model=model)
mesh_util.read("cad_to_append.scdoc", append=True)
mesh_util.read("cad_to_append.dsco", append=True)

Parametric CAD update
---------------------
Expand All @@ -142,7 +150,7 @@

params = prime.ImportCadParams(model=model)
params.cad_reader_route = prime.CadReaderRoute.WORKBENCH
result = prime.FileIO(model).import_cad(file_name="parametric_cad.scdoc", params=params)
result = prime.FileIO(model).import_cad(file_name="parametric_cad.dsco", params=params)

.. code-block:: pycon

Expand All @@ -157,7 +165,7 @@
params = prime.ImportCadParams(model=model)
params.cad_reader_route = prime.CadReaderRoute.WORKBENCH
params.cad_update_parameters = {"my_param": 2}
result = prime.FileIO(model).import_cad(file_name="parametric_cad.scdoc", params=params)
result = prime.FileIO(model).import_cad(file_name="parametric_cad.dsco", params=params)

.. code-block:: pycon

Expand Down
Loading