New tutorials section #1876
Open
New tutorials section #1876
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
luisaFelixSalles
added
the
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## master #1876 +/- ##
=======================================
Coverage 83.96% 83.97%
=======================================
Files 90 90
Lines 10399 10399
=======================================
+ Hits 8732 8733 +1
+ Misses 1667 1666 -1 |
15 tasks
PProfizi
reviewed
Nov 19, 2024
luisaFelixSalles
commented
Dec 4, 2024
* Add custom badges for supported solvers * Test custom badges * Update conf.py * Update doc/source/conf.py Co-authored-by: Revathy Venugopal <[email protected]> --------- Co-authored-by: Revathy Venugopal <[email protected]>
* add a file with refs and links to be used in the doc * add a file with refs and links to be used in the doc
* add animate_data.rst tutorial * completes the animate_data.rst tutorial * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * codes for just one case and erase badges * change tutorial name * last updates * Update animate_time.rst * Fixing moving camera * Apply suggestions from code review Co-authored-by: Luisa Felix Salles <[email protected]> * Update doc/source/user_guide/tutorials/animate/animate_time.rst * Apply suggestions from code review Co-authored-by: JennaPaikowsky <[email protected]> * Apply suggestions from code review Co-authored-by: Luisa Felix Salles <[email protected]> * Apply suggestions from code review * Update doc/source/user_guide/tutorials/animate/animate_time.rst * updates --------- Co-authored-by: Paul Profizi <[email protected]> Co-authored-by: PProfizi <[email protected]> Co-authored-by: JennaPaikowsky <[email protected]>
luisaFelixSalles
force-pushed
the
doc/new-tutorials-section
branch
from
576cd9f to
627c2de
Compare
* add new basic tutorial and jupyter_ sphinx extension * separate the documentation part from the contributing.rst (main page) * create the index page for the writing documentation section * add the tutorials guide lines file * add the tutorial template file * updates the contributing.rst main page * add a separate section for develop code (contributing) * add the writing documentation index page * add new links to links_and_refs.rst * add tutorial_card_template.rst * add tutorial_section_template.rst * add toctree to index file of the write_doc folder * add first part of the guide_lines_tutorials.rst * updates * final first version of guide_lines_tutorials.rst * add tutorial_content_template.rst * add tutorial_structure_template.rst * updates the guide_lines_tutorials.rst with the new tutorial templates refs * updates the guide_lines_tutorials.rst * delete file basic_tutorial.rst * Update doc/source/getting_started/write_doc/guide_lines_tutorials.rst * Update doc/source/getting_started/write_doc/tutorial_structure_template.rst * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * updates the links references in the rst files * updates the links references in the install.rst file * redirect to the PyAnsys guidelines for developing code and add the installation explanation before cloning * redirect to the PyAnsys guidelines for developing documentation * add new links and substitution text to the links_and_refs.rst file * update text in index.rst (write doc) * update the guide_lines_tutorials.rst * update the tutorial_structure_template.rst * add the installing dpf server explanation to the write code index.rst * add the link to the jupyter execute extension doc to the links_and_refs.rst file * rename the guidelines_tutorials.rst file * updates the guidelines_tutorials.rst name in the toctree of the write doc index.rst * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * Update doc/source/getting_started/write_doc/guidelines_tutorials.rst Co-authored-by: Paul Profizi <[email protected]> * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * updates the index.rst of the write doc section * add a new link to the links_and_refs.rst file --------- Co-authored-by: Paul Profizi <[email protected]>
* add new basic tutorial and jupyter_ sphinx extension * add tutorials files * add narrow_down_data.rst tutorial * updates narrow_down_data.rst tutorial * add extract_and_explore_results_metadata.rst tutorial * updates extract_and_explore_results_metadata.rst tutorial * updates extract_and_explore_results_metadata.rst tutorial * updates narrow_down_data.rst tutorial * updates extract_and_explore_results_metadata.rst tutorial * utilise que juptyter sphinx * use only jupyter sphinx: extract_and_explore_results_metadata.rst * add import_result_file.rst tutorial * updates * add extract_and_explore_results_data.rst tutorial * updates on extract_and_explore_results_metadata.rst * add represent_data_on_dpf.rst tutorial * updates on the index page * updates * update the import_result_file.rst to the tutorials guidelines * update the extract_and_explore_results_metadata.rst to the tutorials guidelines * update the extract_and_explore_results_data.rst to the tutorials guidelines * update the index.rst to the tutorials guidelines * update the narrow_down_data.rst to the tutorials guidelines * update the load_custom_data.rst to the tutorials guidelines * update the index.rst to the tutorials guidelines * add solvers badges to the index.rst cards * add solvers badges to the beginning of each tutorial * updates on the text of the load_custom_data.rst turorial * updates on the text of the import_result_file.rst turorial * updates on the text of the load_custom_data.rst turorial * updates on the text of the narrow_down_data.rst tutorial * delete file basic_tutorial.rst * Update doc/source/user_guide/tutorials/import_data/index.rst --------- Co-authored-by: Paul Profizi <[email protected]>
* add new basic tutorial and jupyter_ sphinx extension * add tutorials files and update index page * add get_mesh_from_result_file.rst tutorial * updates on the index * updates on get_mesh_from_result_file.rst * add create_a_mesh_from_scratch.rst tutorial * updates the read the mesh tut * updates the read the mesh tut * add get_specific_part_mesh.rst and split_mesh.rst tutorials * updates on thr get_specific_part_mesh.rst tutorial * updates the create_a_mesh_from_scratch.rst tut * erases add and plot data parts from the create_a_mesh_from_scratch.rst tutorial * update references in get_mesh_from_result_file.rst tutorial * update references in read_mesh.rst tutorial * add second approach to the split_mesh.rst tutorial * updates on get_specific_part_mesh.rst * put a tab for each solver * update * put a tab for each solver in the get_specific_part_mesh.rst tutorial * put a tab for each solver in the split_mesh.rst tutorial * put a tab for each solver and update the read_mesh_metadata.rst tutorial * put a tab for each solver and update the explore_mesh.rst tutorial * put badge for each solver in the main page cards * put badge for each solver in the beginning of the tutorials * update title read_mesh_metadata.rst * update title get_specific_part_mesh.rst * update substitution text * Update doc/source/user_guide/tutorials/mesh/explore_mesh.rst * use only the jupyter sphinx extension * updates the examples package references * update badges in the index.rst * change the section name * add badges in each tutorial * update2 the create_a_mesh_from_scratch.rst tutorial to the tutorials guidelines * update the explore_mesh.rst to the tutorials guidelines * update the extract_mesh_in_split_parts.rst to the tutorials guidelines * update the get_mesh_from_result_file.rst to the tutorials guidelines * update the read_mesh_metadata.rst to the tutorials guidelines * update the split_mesh.rst to the tutorials guidelines * update the index page of the mesh tutorials section * changes the name of the explore_mesh_metadata.rst tutorial * add explanation on the MeshesContainer labels when you use the split_mesh operator on the split_mesh.rst tutorial * add more explanation for each approach on the split_mesh.rst tutorial * add more explanation on the metadata info on the explore_mesh.rst tutorial * add more explanation on the metadata info on the explore_mesh_metadata.rst tutorial * updates on the text of create_a_mesh_from_scratch.rst turorial * Update doc/source/user_guide/tutorials/mesh/explore_mesh_metadata.rst * Update doc/source/user_guide/tutorials/mesh/extract_mesh_in_split_parts.rst * delete file basic_tutorial.rst * correction of a reference in explore_mesh.rst * Fix sentence. Co-authored-by: Camille Bellot <[email protected]> * Refactor search_sequence_numpy in mesh from scratch tutorial Co-authored-by: Muhammed Adedigba <[email protected]> * Fix unordered list Co-authored-by: Jorge Martínez <[email protected]> * Reference nodes, elements, faces, and named selections getters * Refactor query of element type field * Fix unordered list Co-authored-by: Jorge Martínez <[email protected]> * parts -> regions * Fix unordered list Co-authored-by: Jorge Martínez <[email protected]> * Fix unordered list Co-authored-by: Jorge Martínez <[email protected]> * Fix typo Co-authored-by: Camille Bellot <[email protected]> * Fix code snippets formatting Co-authored-by: Camille Bellot <[email protected]> * Fix unordered list * Fix grammar * Fix sentence * Suggestion from Jorge --------- Co-authored-by: Paul Profizi <[email protected]> Co-authored-by: Camille Bellot <[email protected]> Co-authored-by: Muhammed Adedigba <[email protected]> Co-authored-by: Jorge Martínez <[email protected]>
* add new basic tutorial and jupyter_ sphinx extension * add "plotting meshes" example * add files for the others examples * update index page for plotting tuts * add "plotting data on the meshe" example * update "plotting data on the meshe" example * updates * updates on the index page of the plotting section * updates * add plotting_data_on_specific_placements.rst tut * updates * add plotting_a_graph.rst tut * updates * add plot meshes container in plotting_meshes.rst tutorial * add plot meshes container in plotting_meshes.rst tutorial update * add plotting_data_on_deformed_mesh.rst tutorial * updates * erase the adapted examples * add separate plotting_data_on_geometry_elements.rst and plotting_data_on_specific_path.rst tutorials * update substitution text * use only the jupyter sphinx extension * updates the examples package references * update the plotting_meshes.rst to the tutorials guidelines * update the text of the plotting_meshes.rst to the tutorial * update the plotting_data_on_the_mesh.rst to the tutorials guidelines * update the text of the plotting_meshes.rst tutorial * updates the text of the plotting_data_on_the_mesh.rst tutorial * updates the text of the plotting_data_on_the_mesh.rst tutorial * add the plotting_deformed_meshes.rst tutorial * update the plotting_data_on_the_mesh.rst to the tutorials guidelines * update the plotting_meshes.rst to the tutorials guidelines * update the plotting_data_on_specific_path.rst to the tutorials guidelines * update the plotting_data_on_deformed_mesh.rst to the tutorials guidelines * update the plotting_data_on_geometry_elements.rst to the tutorials guidelines * update the plotting_a_graph.rst to the tutorials guidelines * add new links and substitution text to the links_and_refs.rst file * update the card of the plotting a graph tutorial in the index.rst page * delete file basic_tutorial.rst * Revert "erase the adapted examples" This reverts commit a2b474b. * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * updates the files names, references and titles * updates the download buttons * updates the text of the plot_mesh.rst tutorial * updates the text of the plot_deformed_mesh.rst tutorial * updates the text of the plot_data_on_a_mesh.rst tutorial * updates the text of the plot_data_on_custom_geometry.rst tutorial * updates the text of the plot_data_on_custom_path.rst tutorial * Changes to tutorials/plot/index.rst * Changes to tutorials/plot/index.rst * Reword transform data tutorials * Rework plot_a_graph.rst * Fix create_a_mesh_from_scratch.rst * Finish plot_a_graph.rst * Update plot_mesh.rst * Update plot_mesh.rst switch example file * Update mesh plot tutorials * Fix reference to plot_data_on_a_mesh.rst * Refactor plot tutorials list -> one tutorial for contours, one for deformation * Refactor plot tutorials list -> one tutorial for contours, one for deformation * Rework plot_mesh.rst, plot_deformed_mesh.rst, and plot_contour.rst * Fixes to links in plot_a_graph.rst * Remove plot_data_on_custom_path.rst from plot tutorials (it is a mapping tutorial) * Remove plot_data_on_custom_geometry.rst from plot tutorials (it is a mapping tutorial) --------- Co-authored-by: Paul Profizi <[email protected]> Co-authored-by: PProfizi <[email protected]>
* add new basic tutorial and jupyter_ sphinx extension * add math basic tut * updates on the prints * grammar review * update substitution text * use only the jupyter sphinx extension * update the basic_maths.rst to the tutorials guidelines * update the index.rst to the tutorials guidelines * updates on the text of the basic_maths.rst tutorial * delete file basic_tutorial.rst * Apply suggestions from code review Co-authored-by: Jorge Martínez <[email protected]> * Apply suggestions from code review * Update doc/source/user_guide/tutorials/mathematics/basic_maths.rst * First wave of corrections * First wave of corrections * More changes * Rework basic_maths.rst * Correct Lp norm description * Apply suggestions from Jenna Co-authored-by: JennaPaikowsky <[email protected]> --------- Co-authored-by: Jorge Martínez <[email protected]> Co-authored-by: Paul Profizi <[email protected]> Co-authored-by: PProfizi <[email protected]> Co-authored-by: JennaPaikowsky <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR add the tutorials section in the documentation
Preview on how it renders: