switching this lesson to the new Carpentries Workbench Template #23

razoumov · 2024-08-30T21:33:53Z

As discussed at #22, doing this via a PR.

reid-a · 2024-09-02T23:30:59Z

Assignment received, will try to find some bandwidth for this soon.

tkphd

Thank you @razoumov, it's great to see activity on Chapel! It hasn't been updated in a while, and I have avoided scrutinizing since there has not been an active maintainer for several years. My review comments apply to the Workbench conversion (which seems fine), and some edits to the old and revised content for clarity of exposition. I appreciate your efforts on this material.

CITATION.cff

CONTRIBUTING.md

FIXME.Rproj

LICENSE.md

episodes/01-intro.md

episodes/13-synchronization.md

episodes/14-parallel-case-study.md

learners/setup.md

tkphd · 2024-09-14T01:01:13Z

Sounds good! Go ahead and "resolve" anything you consider completed, through discussion or commits.

…

On Sep 13, 2024, 5:46 PM, at 5:46 PM, Alex Razoumov ***@***.***> wrote: @razoumov commented on this pull request. On CITATION.cff: Thank you @tkphd for your thorough review! I will be updating this branch and replying to individual conversations (all 64) in this PR, and if you are happy with the file changes, please mark them as resolved -- does this work for you? Alternatively, I could mark them "resolved" as I work on them, but then you will likely miss some details. Let me know what you prefer. hpc-carpentry/hpc-chapel lessons were originally created by myself and Juan Zuniga. Jeff Stafford did a lot of additional formatting and polishing, and many people have contributed since then. I modified CITATION and CITATION.cff -- does this work? Planning to include more authors when we add new chapters/tracks in the next few months. -- Reply to this email directly or view it on GitHub: #23 (comment) You are receiving this because you were mentioned. Message ID: ***@***.***>

…ting Carpentry

… the description

…viously deleted Exercise 2

… instructions are more of a placeholder for someone to test

… module suggestion; remove .checklist

…ble assignment

…e, n -> outputFrequency

…dded a call-out

…bles with type and/or value

…scussion with an example that will block for sure, and provide the solution/explanation of why it blocks

…dditional restrictions**

…laration and subsetting

tkphd

Excellent edit to ep. 13!

razoumov · 2024-10-01T21:42:04Z

Hi Trevor @tkphd - I believe I went through all the points in your review, closed the ones that have been resolved through a commit, and commented on the rest. At this point my preference would be to merge this PR into the repo, to publish in the new workbench format, and open new issues for any unresolved points in this PR if needed. I know there is an ongoing discussion about using Quarto over the Varnish engine (looking at the meeting agenda, have not attended the meetings for a while). If there is an organization-wide HPC Carpentry transition to Quarto, I am happy to adopt it for HPC Chapel in a future PR (that someone more familiar with Quarto should create), but at this point I would prefer to merge the already committed extensive set of changes into the repo. What are your thoughts?

tkphd

I don't think the LICENSE needs a separate section for software, as there are no software source code artifacts in the repository, only code-blocks in the Markdown-formatted plain text. This falls under normal copyright, not software licensing, but is also not hugely important.

tkphd · 2024-10-02T15:46:29Z

episodes/02-variables.md

+- "Know how to define and use data stored as variables."
+::::::::::::::::::::::::::::::::::::::::::::::::
+
+Using basic maths in Chapel is fairly intuitive. Try compiling the following code to see


Contextualize this for beginners, like the Ep. 1 examples:
Open a text editor and populate the document with these lines; save it as operators.chpl; compile and run with the following command.

tkphd · 2024-10-02T15:48:42Z

episodes/02-variables.md

+It can span as many lines as you want!
+(like this) */
+```
+


Better practice would make that edit, or create a block comment describing what the code does in operators.chpl, then recompile & run. This will catch a few learners' typos.

tkphd · 2024-10-02T15:51:50Z

episodes/02-variables.md

+
+
+
+


Too many blank lines.

tkphd · 2024-10-02T15:54:26Z

episodes/02-variables.md

+
+```chpl
+const test = 100;
+writeln('The value of test is ', test, ' and its type is ', test.type:string);


Neato, and please talk through the syntax of test.type:string

Auto-generated via {sandpaper} Source : 89c58a3 Branch : main Author : Trevor Keller <[email protected]> Time : 2024-10-08 19:13:39 +0000 Message : Merge pull request #23 from hpc-carpentry/dev-workbench switching this lesson to the new Carpentries Workbench Template

Auto-generated via {sandpaper} Source : cf65a56 Branch : md-outputs Author : GitHub Actions <[email protected]> Time : 2024-10-08 19:15:25 +0000 Message : markdown source builds Auto-generated via {sandpaper} Source : 89c58a3 Branch : main Author : Trevor Keller <[email protected]> Time : 2024-10-08 19:13:39 +0000 Message : Merge pull request #23 from hpc-carpentry/dev-workbench switching this lesson to the new Carpentries Workbench Template

tkphd · 2024-10-08T19:20:34Z

@razoumov I merged this PR, and the build "succeeded," but the rendered site does not look correct:
https://www.hpc-carpentry.org/hpc-chapel/

razoumov · 2024-10-09T02:33:13Z

Thank you @tkphd for merging this pull request! I restarted the Pages built process (switched the site source to None and then back to gh-pages), and it now built the website properly https://www.hpc-carpentry.org/hpc-chapel

tkphd · 2024-10-09T17:26:53Z

Excellent! Thanks @razoumov

Auto-generated via `{sandpaper}` Source : cf65a56 Branch : md-outputs Author : GitHub Actions <[email protected]> Time : 2024-10-08 19:15:25 +0000 Message : markdown source builds Auto-generated via {sandpaper} Source : 89c58a3 Branch : main Author : Trevor Keller <[email protected]> Time : 2024-10-08 19:13:39 +0000 Message : Merge pull request #23 from hpc-carpentry/dev-workbench switching this lesson to the new Carpentries Workbench Template

switching this lesson to the new Carpentries Workbench Template

a19df5b

razoumov mentioned this pull request Aug 30, 2024

Revamping Chapel lessons #22

Open

razoumov assigned reid-a Aug 30, 2024

tkphd requested review from tkphd and reid-a September 5, 2024 11:29

tkphd requested changes Sep 13, 2024

View reviewed changes

update CITATION and CITATION.cff

998b54c

Alex Razoumov added 21 commits September 16, 2024 08:59

rename FIXME.Rproj to hpc-chapel.Rproj

546ea9c

edit FIXME tags in CONTRIBUTING.md and config.yaml

88ac528

change all Carpentries references and links to High Performance Compu…

a345b2e

…ting Carpentry

remove references to Cray (that no longer exists); add open-source in…

63c3f85

… the description

fix the 'form' typo in the code and output

93e6b62

rewrite text in 14-parallel-case-study.md to remove references to pre…

fc3b50f

…viously deleted Exercise 2

remove prompt characters from bash blocks in all files

7f36b65

make the keypoints in 14-parallel-case-study.md more specific

ce5893d

add Chapel installation instructions for Mac, Linux, Windows; Windows…

9545546

… instructions are more of a placeholder for someone to test

add more generic 'module avail chapel' advice instead of the specific…

9b606c0

… module suggestion; remove .checklist

corrected a typo

a5543b6

rewrite wording around 'basic maths'

5c72240

remove the paragraph distinguishing variable initialization and varia…

6cd1e50

…ble assignment

add a call-out where we try to use an un-initialized variable

573402d

update the error message to 'cannot assign to const variable'

5243788

floating-point division

c5f409d

edit wording on memory

6a43014

change variable names: tt -> tmp, curdif -> delta, mindif -> toleranc…

c8f1e34

…e, n -> outputFrequency

at compile-time

0c328d3

mixed initialization and assignment: new wording, corrected syntax, a…

899c5d6

…dded a call-out

rewrite 02-variables.md: first const vs. var, then initializing varia…

a6a92cf

…bles with type and/or value

Alex Razoumov added 13 commits September 24, 2024 12:16

explain that *sync* can be either a statement or a type qualifier

0dd9f33

update the code for Chapel 2.x

cbd7f25

explain the example with writeEF/readFF in more detail; change the di…

cadea23

…scussion with an example that will block for sure, and provide the solution/explanation of why it blocks

correct style

7b29ed4

reformulate the key point about all variables having a type

21db06a

break procedure definitions and usage into separate code blocks

b5b6d20

use dashes for itemized lists; restore original indentation in **No a…

bc91fe2

…dditional restrictions**

switch to using dashes for itemized lists through all chapters

6a41eb3

use temp variable to write the solution to disk

23b7c07

move first mention of arrays down the text

bd3d7e6

introduce a very simple loop to show range usage

c13a37e

remove *One final thing*

85c1a07

add a sentence about the dual use of square brackets with arrays: dec…

1e1b70a

…laration and subsetting

tkphd reviewed Oct 1, 2024

View reviewed changes

Updated human-readable license text.

ab35382

tkphd approved these changes Oct 2, 2024

View reviewed changes

tkphd merged commit 89c58a3 into main Oct 8, 2024
2 checks passed

tkphd deleted the dev-workbench branch October 8, 2024 19:14

DanilaFe mentioned this pull request Nov 14, 2024

Outdated README instructions for serving break new workbench template #24

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

switching this lesson to the new Carpentries Workbench Template #23

switching this lesson to the new Carpentries Workbench Template #23

razoumov commented Aug 30, 2024

reid-a commented Sep 2, 2024

tkphd left a comment

tkphd commented Sep 14, 2024 via email

tkphd left a comment

razoumov commented Oct 1, 2024

tkphd left a comment

tkphd Oct 2, 2024

tkphd Oct 2, 2024

tkphd Oct 2, 2024

tkphd Oct 2, 2024

tkphd commented Oct 8, 2024

razoumov commented Oct 9, 2024

tkphd commented Oct 9, 2024

switching this lesson to the new Carpentries Workbench Template #23

switching this lesson to the new Carpentries Workbench Template #23

Conversation

razoumov commented Aug 30, 2024

reid-a commented Sep 2, 2024

tkphd left a comment

Choose a reason for hiding this comment

tkphd commented Sep 14, 2024 via email

tkphd left a comment

Choose a reason for hiding this comment

razoumov commented Oct 1, 2024

tkphd left a comment

Choose a reason for hiding this comment

tkphd Oct 2, 2024

Choose a reason for hiding this comment

tkphd Oct 2, 2024

Choose a reason for hiding this comment

tkphd Oct 2, 2024

Choose a reason for hiding this comment

tkphd Oct 2, 2024

Choose a reason for hiding this comment

tkphd commented Oct 8, 2024

razoumov commented Oct 9, 2024

tkphd commented Oct 9, 2024