Wipe cycstub repo #419

gonuke · 2025-05-30T18:55:52Z

This removes references to the cycstub repo and instead replaces it with reference to the cycstub utility. This leaves one file untouched because it is slated to be removed in #418 .

cmake.rst still needs a closer review, but this could be left to a different PR??

Fixes #197 and #366

abachma2

This generally looks good to me. I recommend some of the capitalization is consistent with 1856 in Cyclus.

source/arche/cmake.rst

source/arche/hello_world_cpp.rst

abachma2 · 2025-05-30T19:57:48Z

source/arche/tour_cpp.rst

+  cycstub --type facility :stublibrary:StubFacility
+  cycstub --type institution :stublibrary:StubInstitution
+  cycstub --type region :stublibrary:StubRegion


Do we want these to have CamelCase in the library name?

I did it this way before I committed to fixing the CamelCase problem. In the fixed version, all combinations will work successfully, so these don't need to change.

gonuke · 2025-05-31T01:15:18Z

source/arche/hello_world_cpp.rst

@@ -4,48 +4,32 @@ Hello, Cyclus! [C++]
 ====================
 This pages walks you through a very simple hello world example using
 |cyclus| agents.  First make sure that you have the dependencies installed,
-namely |Cyclus|, CMake, and a recent version of Python (2.7 or 3.3+).
+namely |Cyclus|, CMake, and a recent version of Python (3.3+).


I'm not sure what our minimum version is these days????

My guess would be python 3.9, but I can look around.

Going off of the dependencies for installing cyclus via conda, it looks like 3.8 is the lowest version allowed. I can build cyclus with 3.8 locally, but the unit tests won't pass unless you have python 3.11+, as of commit 4d1eeef5

gonuke · 2025-05-31T01:37:32Z

I reverted this to draft because a little more work needs to be done to make it all consistent and useful.

gonuke · 2025-06-03T14:56:01Z

I think this is probably where this needs to be to be consistent now.

dean-krueger

The only two comments I have are the same PascalCase vs camelCase comment I made in the other PR #1856, and that (and I'm not sure if this really needs to be fixed), but a naive version of me would probably try to type the command tutorial $ cycstub --type inst tutorial:TutorialLibrary:TutorialInstitution instead of the command cycstub --type inst tutorial:TutorialLibrary:TutorialInstitution in the tutorial folder. Perhaps if you copy the command from the markdown file it is smart enough to not give you that part, but just a thought! Otherwise this looks good to me.

gonuke · 2025-06-11T13:24:31Z

but a naive version of me would probably try to type the command tutorial $ cycstub --type inst tutorial:TutorialLibrary:TutorialInstitution instead of the command cycstub --type inst tutorial:TutorialLibrary:TutorialInstitution in the tutorial folder

I think we've often wondered whether it makes sense to include the prompt in the samples. I'm torn on this. The only real benefit is that you can see the directory change and the user gets some clear feedback on which directory they should be in to run the command. The downside is that it looks like part of the command... we could try a different prompt separator... maybe:

(/home/tutorial) |> command here

dean-krueger · 2025-06-12T22:41:12Z

I'm not sure the separator is really the problem, since ultimately this "issue" is with people who aren't that familiar with using the terminal. I wonder how other people handle this when writing documentation. I guess my personal preference is to change:

"""
You can add additional agents to this module by calling cycstub multiple times:

    tutorial $ python rename.py tutorial
    tutorial $ cycstub --type inst tutorial:TutorialLibrary:TutorialInstitution
    tutorial $ cycstub --type region tutorial:TutorialLibrary:TutorialRegion

"""

Into something like:

"""
You can add additional agents to this module by calling cycstub multiple times.

From the "tutorial" directory, run:

    python rename.py tutorial
    cycstub --type inst tutorial:TutorialLibrary:TutorialInstitution
    cycstub --type region tutorial:TutorialLibrary:TutorialRegion

"""

But perhaps that's too verbose/much overhead/easy to miss? Ultimately I don't think it matters much (except that actually this makes the commands really easy to copy form the markdown file and paste in your terminal since you don't have to remove the tutorial $ bit from every line), but wanted to point this out.

gonuke · 2025-06-13T13:31:24Z

I just updated all the code-blocks to be type console instead of type bash to hopefully get syntax highlighting to help with this

A few typos and copyedit improvements Co-authored-by: Amanda Bachmann <[email protected]>

gonuke · 2025-06-13T15:40:35Z

All the bash code blocks now have sytnax highlighting that requires the prompt to be indicated with only a single $ (there may be other options, but indicating the directory name is definitely not allowed).

dean-krueger

Thanks @gonuke for making that change. This looks good to me now. I'll leave it unmerged until Wednesday morning to give others a chance to look at it on Monday if they want (I know @abachma2 mentioned wanting some time after TWOFCS to check things). If others get around to it before then, and approve, feel free to merge.

abachma2

Thanks @gonuke. I am approving this PR. I have one comment to follow up on the minimum python version. If we don't have any more conversation about that then I will merge.

abachma2 · 2025-06-06T20:07:51Z

source/arche/hello_world_cpp.rst

@@ -4,48 +4,32 @@ Hello, Cyclus! [C++]
 ====================
 This pages walks you through a very simple hello world example using
 |cyclus| agents.  First make sure that you have the dependencies installed,
-namely |Cyclus|, CMake, and a recent version of Python (2.7 or 3.3+).
+namely |Cyclus|, CMake, and a recent version of Python (3.3+).


Going off of the dependencies for installing cyclus via conda, it looks like 3.8 is the lowest version allowed. I can build cyclus with 3.8 locally, but the unit tests won't pass unless you have python 3.11+, as of commit 4d1eeef5

abachma2

LGTM. Merging now.

gonuke requested review from abachma2 and dean-krueger May 30, 2025 19:50

gonuke self-assigned this May 30, 2025

abachma2 reviewed May 30, 2025

View reviewed changes

gonuke commented May 31, 2025

View reviewed changes

gonuke marked this pull request as draft May 31, 2025 01:37

gonuke marked this pull request as ready for review June 3, 2025 14:55

gonuke requested a review from abachma2 June 6, 2025 14:59

dean-krueger reviewed Jun 10, 2025

View reviewed changes

gonuke and others added 11 commits June 13, 2025 08:32

update to align with cycstub usage

364d292

update for current cycstub usage

5741731

initial updates for current cycstub usage

81ef584

make sure narrative is consistent with bash cmds

9473224

Copyedit from @abachma2

27cf707

A few typos and copyedit improvements Co-authored-by: Amanda Bachmann <[email protected]>

more consistency

2cc538a

switch to camelcase for module name in tutorial

7ef8007

Make samples consistent with current implementation

f43aaf6

introduced tutorial path into example (even if it may be ignored?)

a2356c5

redorder module vs standalone discussion

c41a394

update code-block types for highlighting

6ad43cf

gonuke force-pushed the wipe_cycstub_repo branch from 5f0bae3 to 6ad43cf Compare June 13, 2025 13:32

gonuke added 2 commits June 13, 2025 08:37

update code-block types for highlighting

e1238b7

remove directory hints from code blocks

46417e5

dean-krueger approved these changes Jun 14, 2025

View reviewed changes

abachma2 approved these changes Jun 17, 2025

View reviewed changes

Advance python version aggressively

573d153

abachma2 reviewed Jun 18, 2025

View reviewed changes

abachma2 merged commit e4b518f into cyclus:source Jun 18, 2025
2 checks passed

gonuke mentioned this pull request Jun 20, 2025

C++ Tutorial "Hello World" has incorrect install instructions #366

Open

Wipe cycstub repo #419

Wipe cycstub repo #419

Uh oh!

Conversation

gonuke commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

abachma2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abachma2 May 30, 2025

Choose a reason for hiding this comment

Uh oh!

gonuke May 31, 2025

Choose a reason for hiding this comment

Uh oh!

gonuke May 31, 2025

Choose a reason for hiding this comment

Uh oh!

abachma2 Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

abachma2 Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

gonuke commented May 31, 2025

Uh oh!

gonuke commented Jun 3, 2025

Uh oh!

dean-krueger left a comment

Choose a reason for hiding this comment

Uh oh!

gonuke commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dean-krueger commented Jun 12, 2025

Uh oh!

gonuke commented Jun 13, 2025

Uh oh!

gonuke commented Jun 13, 2025

Uh oh!

dean-krueger left a comment

Choose a reason for hiding this comment

Uh oh!

abachma2 left a comment

Choose a reason for hiding this comment

Uh oh!

abachma2 Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

abachma2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gonuke commented May 30, 2025 •

edited

Loading

gonuke commented Jun 11, 2025 •

edited

Loading