Second tutorial about time dependent data #564

vhirtham · 2021-09-27T15:04:46Z

Changes

Add the second tutorial about time-dependent data

Todo

Link first tutorial
Add to "Getting started"
xarray examples -> mean, min, max

review-notebook-app · 2021-09-27T15:04:50Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

vhirtham · 2021-09-29T14:48:40Z

Notes

plot first
small data processing example (mean value)

CagtayFabry · 2021-09-30T09:13:17Z

can you update the single_pass_weld schema in a separate PR to point to TimeSeries @vhirtham ?

Or maybe we should allow both for now?

vhirtham · 2021-10-01T08:18:43Z

can you update the single_pass_weld schema in a separate PR to point to TimeSeries @vhirtham ?

Or maybe we should allow both for now?

I will create a separate PR pointing to the master branch

vhirtham · 2021-10-01T11:03:52Z

@marscher @CagtayFabry no clue why deepsource is complaining here. The function is in the file and I didn't touch it either. Any clue? If not I will ignore it for now. If it keeps showing up, I will add a flag for deepsource to ignore it, before we merge everything into master.

codecov · 2021-10-01T11:21:43Z

Codecov Report

Merging #564 (1897206) into new_tutorials (b2a3920) will not change coverage.
The diff coverage is n/a.

@@              Coverage Diff               @@
##           new_tutorials     BAMWelDX/weldx#564   +/-   ##
==============================================
  Coverage          94.65%   94.65%           
==============================================
  Files                 93       93           
  Lines               5936     5936           
==============================================
  Hits                5619     5619           
  Misses               317      317

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b2a3920...1897206. Read the comment docs.

github-actions · 2021-10-14T08:46:59Z

Unit Test Results

      1 files ±0       1 suites ±0 2m 4s ⏱️ +13s
1 923 tests ±0 1 923 ✔️ ±0 0 💤 ±0 0 ❌ ±0

Results for commit 1897206. ± Comparison against base commit b2a3920.

♻️ This comment has been updated with latest results.

tutorials/01_02_time_dependent_data.ipynb

Co-authored-by: Cagtay Fabry <43667554+CagtayFabry@users.noreply.github.com>

vhirtham · 2021-10-26T08:41:04Z

One bad thing about using RST: The link syntax collides with the markdown inline code syntax. See "Further readings" section here ... I'll try using HTML as an alternative

CagtayFabry · 2021-10-26T08:51:18Z

One bad thing about using RST: The link syntax collides with the markdown inline code syntax. See "Further readings" section here ... I'll try using HTML as an alternative

I guess you meant this snippet?

[API tutorial: `TimeSeries`](timeseries_01.ipynb)`

I can see how that could be troublesome for the parser, but a normal link without inline code styling should also be fine here :)

vhirtham · 2021-10-26T08:57:16Z

[API tutorial: `TimeSeries`](timeseries_01.ipynb)`
I can see how that could be troublesome for the parser, but a normal link without inline code styling should also be fine here :)

That works, yes.

I tried this one now:

[API tutorial: <code>TimeSeries</code>](timeseries_01.ipynb)

Works in the NBs and it should also work in the online version. We will know in a few minutes 😉

vhirtham · 2021-10-26T09:15:50Z

We will know in a few minutes 😉

Works (good enough).

CagtayFabry · 2021-10-26T16:05:39Z

tutorials/01_02_time_dependent_data.ipynb

+    "Depending on the Python environment you are using, there are some things to consider.\n",
+    "Since the `plot` method uses `matplotlib` internally, you have to call the `matplotlib.pyplot.show` function manually after using `plot` when running a regular Python script file.\n",
+    "Otherwise, the plot won't show up.\n",
+    "\n",


I would prefer to leave this part out since we are in a notebook here, talking matplotlib or even other IDEs is confusing imo.

If somebody reads our online doc, he is not using any environment at all. I know, I keep repeating myself, but I don't think it is wise to expect that every future WelDX user will also use Jupyter.

So IMO 3 sentences to avoid confusion beneath the Python userbase isn't too confusing for other people. Also, even if the tutorials are written in Jupyter, they are general WelDX tutorials and not "WelDX in Jupyter" tutorials.

As an alternative I can shorten it to a Hint like this:

HINT: In a Python script, you need to call matplotlib.pyplot.show function manually to actually see the plots

As discussed, we will leave it in for now

CagtayFabry · 2021-10-26T16:06:24Z

tutorials/01_02_time_dependent_data.ipynb

+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# %matplotlib widget"
+   ]


can we uncomment this cell and hide+skip in the docs build?

I think hiding it in the docs doesn't make much sense when the preceding sentence is:

To enable interactive matplotlib plots inside a jupyter notebook, uncomment and run the following magic command:

However, I can try uncommenting it and we will see what happens. Maybe it magically works.

Didn't work. Solution postponed

Finish first draft of second tutorial

5ef9e33

vhirtham added the documentation Improvements or additions to documentation label Sep 27, 2021

vhirtham self-assigned this Sep 27, 2021

vhirtham added 2 commits September 30, 2021 17:44

Update tutorial

d878aaa

Update text

97e6c01

vhirtham marked this pull request as ready for review October 1, 2021 07:55

Merge branch 'new_tutorials' into simple_data

7821c2a

vhirtham added 3 commits October 1, 2021 10:55

Fix file name in tutorial

2a613d1

Try fix doc

07aa4d2

Fix doc

63b0837

vhirtham requested review from CagtayFabry and marscher October 1, 2021 11:05

Fix typos

41680c2

vhirtham added 5 commits October 14, 2021 09:46

Rename tutorial file

5cfc88b

Merge branch 'new_tutorials' into simple_data

39523f8

Update tutorial

81cf4d3

Merge branch 'new_tutorials' into simple_data

4d36639

Update tutorial

5a7b65a

vhirtham requested a review from AndreasPittner October 14, 2021 08:38

CagtayFabry reviewed Oct 15, 2021

View reviewed changes

tutorials/01_02_time_dependent_data.ipynb Outdated Show resolved Hide resolved

vhirtham added 3 commits October 25, 2021 09:03

Merge branch 'new_tutorials' into simple_data

6667a13

Add link

1d1e8be

Add tutorial to getting started

f4ccd58

vhirtham added 4 commits October 25, 2021 10:05

Update link

0f6fb11

Add example section

222a4a4

Fix pre-commit

ece46a6

add previous and next links

1da5945

vhirtham requested a review from CagtayFabry October 25, 2021 15:04

vhirtham and others added 5 commits October 26, 2021 09:42

update link

f5e86aa

Update tutorials/01_02_time_dependent_data.ipynb

03c94b4

Co-authored-by: Cagtay Fabry <43667554+CagtayFabry@users.noreply.github.com>

Fix notebook

d9b8d4e

Remove empty cell

936afd2

Clean notebook

589144f

vhirtham added 2 commits October 26, 2021 10:45

Update code section in link

2f43a10

Remove empty cell

63cb2d3

Fix link

0567b14

CagtayFabry reviewed Oct 26, 2021

View reviewed changes

CagtayFabry approved these changes Oct 26, 2021

View reviewed changes

vhirtham added 3 commits October 27, 2021 09:50

Uncomment magic command

f59670f

Undo previous commit

2d355af

Merge branch 'new_tutorials' into simple_data

1897206

vhirtham merged commit 37d389e into BAMWelDX:new_tutorials Nov 3, 2021

vhirtham deleted the simple_data branch November 3, 2021 14:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Second tutorial about time dependent data #564

Second tutorial about time dependent data #564

vhirtham commented Sep 27, 2021 •

edited

Loading

review-notebook-app bot commented Sep 27, 2021

vhirtham commented Sep 29, 2021

CagtayFabry commented Sep 30, 2021

vhirtham commented Oct 1, 2021

vhirtham commented Oct 1, 2021

codecov bot commented Oct 1, 2021 •

edited

Loading

github-actions bot commented Oct 14, 2021 •

edited

Loading

vhirtham commented Oct 26, 2021

CagtayFabry commented Oct 26, 2021

vhirtham commented Oct 26, 2021 •

edited

Loading

vhirtham commented Oct 26, 2021

CagtayFabry Oct 26, 2021

vhirtham Oct 27, 2021

vhirtham Nov 3, 2021

CagtayFabry Oct 26, 2021

vhirtham Oct 27, 2021 •

edited

Loading

vhirtham Nov 3, 2021

Second tutorial about time dependent data #564

Second tutorial about time dependent data #564

Conversation

vhirtham commented Sep 27, 2021 • edited Loading

Changes

Todo

review-notebook-app bot commented Sep 27, 2021

vhirtham commented Sep 29, 2021

CagtayFabry commented Sep 30, 2021

vhirtham commented Oct 1, 2021

vhirtham commented Oct 1, 2021

codecov bot commented Oct 1, 2021 • edited Loading

Codecov Report

github-actions bot commented Oct 14, 2021 • edited Loading

Unit Test Results

vhirtham commented Oct 26, 2021

CagtayFabry commented Oct 26, 2021

vhirtham commented Oct 26, 2021 • edited Loading

vhirtham commented Oct 26, 2021

CagtayFabry Oct 26, 2021

Choose a reason for hiding this comment

vhirtham Oct 27, 2021

Choose a reason for hiding this comment

vhirtham Nov 3, 2021

Choose a reason for hiding this comment

CagtayFabry Oct 26, 2021

Choose a reason for hiding this comment

vhirtham Oct 27, 2021 • edited Loading

Choose a reason for hiding this comment

vhirtham Nov 3, 2021

Choose a reason for hiding this comment

vhirtham commented Sep 27, 2021 •

edited

Loading

codecov bot commented Oct 1, 2021 •

edited

Loading

github-actions bot commented Oct 14, 2021 •

edited

Loading

vhirtham commented Oct 26, 2021 •

edited

Loading

vhirtham Oct 27, 2021 •

edited

Loading