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.

Sign up for GitHub

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

Jump to bottom

Add import data tutorials to the main tutorials section #1933

Open
wants to merge 32 commits into
base: doc/new-tutorials-section
Choose a base branch
from
Open

Add import data tutorials to the main tutorials section #1933

wants to merge 32 commits into from

Conversation

luisaFelixSalles
Copy link
Collaborator

@luisaFelixSalles luisaFelixSalles commented Nov 25, 2024 •
edited
Loading

Add the import data tutorials

List of tutorials:

  • Load custom data
  • Import a result file in DPF
  • Extract and explore results metadata
  • Extract and explore results data
  • Narrow down data

Preview on how it renders

Import data section main page

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_import_data_index html (1)

Load custom data

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_import_data_load_custom_data html (2)

Import a result file in DPF

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_import_data_import_result_file html (3)

Extract and explore results metadata

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_import_data_extract_and_explore_results_metadata html (2)

Extract and explore results data

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_import_data_extract_and_explore_results_data html (2)

Narrow down data

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_import_data_narrow_down_data html (2)

@luisaFelixSalles luisaFelixSalles added the tutorials Related to PyDPF-Core tutorials label Nov 25, 2024
@luisaFelixSalles luisaFelixSalles self-assigned this Nov 25, 2024
@codecov Codecov
Copy link

codecov bot commented Nov 25, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.42%. Comparing base (627c2de) to head (6606b69).

Additional details and impacted files 
@@                      Coverage Diff                      @@
##           doc/new-tutorials-section    #1933      +/-   ##
=============================================================
- Coverage                      88.50%   88.42%   -0.09%     
=============================================================
  Files                             89       89              
  Lines                          10251    10251              
=============================================================
- Hits                            9073     9064       -9     
- Misses                          1178     1187       +9

PProfizi
PProfizi reviewed Nov 26, 2024
View reviewed changes
doc/source/user_guide/tutorials/import_data/represent_data_on_dpf.rst Outdated
Defining the fields
-------------------

To manually import data on DPF you have to create the structure to store it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To manually import data on DPF you have to create the structure to store it.
To import custom data into DPF you first have to create the structure to store it.

@luisaFelixSalles luisaFelixSalles mentioned this pull request Nov 25, 2024
Open
36 tasks
@luisaFelixSalles luisaFelixSalles force-pushed the tutorials/import-data/firsts-import-data-tutorials branch from 2e1c8d9 to b1fefc4 Compare December 11, 2024 10:45
@luisaFelixSalles luisaFelixSalles force-pushed the doc/new-tutorials-section branch from 576cd9f to 627c2de Compare December 19, 2024 16:42
@luisaFelixSalles
updates
e5a2c80
@luisaFelixSalles
add extract_and_explore_results_data.rst tutorial
ab6349e
@luisaFelixSalles
updates on extract_and_explore_results_metadata.rst
704616e
@luisaFelixSalles
add represent_data_on_dpf.rst tutorial
a26dfa0
@luisaFelixSalles
updates on the index page
4de3038
@luisaFelixSalles
updates
2d283c4
@luisaFelixSalles
update the import_result_file.rst to the tutorials guidelines
ffb447d
@luisaFelixSalles
update the extract_and_explore_results_metadata.rst to the tutorials …
f317d9c 
…guidelines
@luisaFelixSalles
update the extract_and_explore_results_data.rst to the tutorials guid…
6d359ed 
…elines
@luisaFelixSalles
update the index.rst to the tutorials guidelines
61e75fc
@luisaFelixSalles
update the narrow_down_data.rst to the tutorials guidelines
f5662fe
@luisaFelixSalles
update the load_custom_data.rst to the tutorials guidelines
a09db36
@luisaFelixSalles
update the index.rst to the tutorials guidelines
72b16dc
@luisaFelixSalles
add solvers badges to the index.rst cards
92c506b
@luisaFelixSalles
add solvers badges to the beginning of each tutorial
4b42702
@luisaFelixSalles
updates on the text of the load_custom_data.rst turorial
5e9e7e1
@luisaFelixSalles
updates on the text of the import_result_file.rst turorial
ec3e3a3
@luisaFelixSalles
updates on the text of the load_custom_data.rst turorial
313bddd
@luisaFelixSalles
updates on the text of the narrow_down_data.rst tutorial
46c7d42
@luisaFelixSalles
delete file basic_tutorial.rst
6606b69
@luisaFelixSalles luisaFelixSalles force-pushed the tutorials/import-data/firsts-import-data-tutorials branch from 3e2df72 to 6606b69 Compare December 20, 2024 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PProfizi PProfizi PProfizi left review comments

@jorgepiloto jorgepiloto Awaiting requested review from jorgepiloto

@moe-ad moe-ad Awaiting requested review from moe-ad

Assignees

@luisaFelixSalles luisaFelixSalles

Labels
tutorials Related to PyDPF-Core tutorials
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@luisaFelixSalles @PProfizi