New proposition for the tutorials section layout #1779
Conversation
luisaFelixSalles
added
the
documentation
| There are four main steps to transform simulation data into output data that can | ||
| be used to visualize and analyze simulation results: |
There was a problem hiding this comment.
To be discussed further. I think it would be better to mention different categories of actions you can perform with PyDPF-Core. The end-goal of using PyDPF-Core is not necessarily to visualize and analyze.
Maybe something along the lines of: "There are different kind of actions you can perform: from extracting result from result files, to visualization of extracted data, to filtering, transformation of the data, and much more."
|
|
||
| **Load data** | ||
|
|
||
| .. topic:: Importing and opening results files |
There was a problem hiding this comment.
| .. topic:: Importing and opening results files | |
| .. topic:: Extract data from result files |
There was a problem hiding this comment.
I don't know if using "extract " here is a great idea. Because in the other section we talk about extracting (like if I want to have a displacement result). So here is it actually extract a result?
| .. grid:: 3 | ||
|
|
||
| Fields | ||
| .. grid-item-card:: I have one file |
There was a problem hiding this comment.
| .. grid-item-card:: I have one file | |
| .. grid-item-card:: Extract data from a single file |
| :text-align: center | ||
|
|
||
| PropertyField | ||
| Import and open a single result file with PyDPF-Core. |
There was a problem hiding this comment.
| Import and open a single result file with PyDPF-Core. | |
| Extract data from a single result file with PyDPF-Core. |
| Import and open a single result file with PyDPF-Core. | ||
|
|
||
| StringField | ||
| .. grid-item-card:: I have more than one file |
There was a problem hiding this comment.
| .. grid-item-card:: I have more than one file | |
| .. grid-item-card:: Extract data from distributed result files |
There was a problem hiding this comment.
And the idea would be to also add a tutorial for:
- when you have accessory files
- when you have upstream result files
- and so on
There was a problem hiding this comment.
Yes. If you have more than one file the tutorial will talk about these cases
Co-authored-by: Paul Profizi <[email protected]>
| There are four main steps to transform simulation data into output data that can | ||
| be used to visualize and analyze simulation results: |
There was a problem hiding this comment.
| There are four main steps to transform simulation data into output data that can | |
| be used to visualize and analyze simulation results: | |
| There are different kind of actions you can perform with PyDPF-Core: from extracting result from result files, to visualization of extracted data, to filtering, transformation of the data, and much more. | |
| Nevertheless, we can summarize in four main steps the process of transforming simulation data into post-processed output data : |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## doc/general-layout #1779 +/- ##
=====================================================
Coverage ? 85.78%
=====================================================
Files ? 83
Lines ? 9948
Branches ? 0
=====================================================
Hits ? 8534
Misses ? 1414
Partials ? 0 |
This PR brings a new proposition for the tutorials section layout
Preview on how it renders: