Skip to content

Commit d744415

Browse files
updates in the DataSources api reference
1 parent 07a7682 commit d744415

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/ansys/dpf/core/data_sources.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -205,12 +205,13 @@ def guess_result_key(filepath: str) -> str:
205205
>>> # Create the DataSources object
206206
>>> my_data_sources = dpf.DataSources()
207207
>>> # Download the result files
208-
>>> path = examples.find_simple_bar()
208+
>>> path = examples.download_d3plot_beam()
209209
>>> # Define the path where the main result file can be found
210-
>>> my_data_sources.set_result_file_path(filepath=path)
210+
>>> my_data_sources.set_result_file_path(filepath=path[0])
211211
>>> # Define the extension key for the file in the given path
212-
>>> my_file_key = my_data_sources.guess_result_key(filepath=path)
213-
'rst'
212+
>>> my_file_key = my_data_sources.guess_result_key(filepath=path[0])
213+
>>> print(my_file_key)
214+
'd3plot'
214215
215216
"""
216217
result_keys = ["d3plot", "binout"]
@@ -246,14 +247,13 @@ def guess_second_key(filepath: str) -> str:
246247
>>> paths = examples.download_fluent_axial_comp()
247248
>>> # Create the DataSources object
248249
>>> my_data_sources = dpf.DataSources()
249-
>>> # Define the path where the main result file can be found
250+
>>> # Define the extension key for the file in the given path
250251
>>> # We see that the paths are given in a dictionary.
251252
>>> # So to choose the correct file you need to give as an argument:
252253
>>> # - the list label
253254
>>> # - the file index in that list
254-
>>> my_data_sources.set_result_file_path(filepath=paths['cas'][0])
255-
>>> # Define the extension key for the file in the given path
256-
>>> my_file_key = my_data_sources.guess_second_key(filepath=paths['cas'][0])
255+
>>> my_file_key = my_data_sources.guess_second_key(filepath=paths["cas"][0])
256+
>>> print(my_file_key)
257257
'cas'
258258
259259
"""
@@ -503,7 +503,7 @@ def add_upstream_for_domain(self, upstream_data_sources: DataSources, domain_id:
503503
504504
>>> from ansys.dpf import core as dpf
505505
>>> from ansys.dpf.core import examples
506-
506+
>>>
507507
>>> # Download the result files
508508
>>> paths = examples.find_distributed_msup_folder()
509509
>>> # Create the main DataSources object
@@ -609,7 +609,7 @@ def result_files(self):
609609
>>>
610610
>>> # Get the path to the main result file of the main DataSources object
611611
>>> my_data_sources.result_files
612-
['../site-packages/ansys/dpf/core/examples/result_files/msup/file.rfrq']
612+
>>> # ['../site-packages/ansys/dpf/core/examples/result_files/msup/file.rfrq']
613613
614614
- If you are checking the DataSources object created to define the upstream data, only the first one is listed.
615615

0 commit comments

Comments
 (0)