From 1387f8266652ac986d027755b5bb6e6db0c2f373 Mon Sep 17 00:00:00 2001 From: bennibbelink <79653949+bennibbelink@users.noreply.github.com> Date: Thu, 12 Sep 2024 21:13:55 -0400 Subject: [PATCH] update cycstub installation instructions --- source/arche/tour_cpp.rst | 28 +++++----------------------- source/arche/tutorial_cpp/index.rst | 2 +- 2 files changed, 6 insertions(+), 24 deletions(-) diff --git a/source/arche/tour_cpp.rst b/source/arche/tour_cpp.rst index a0ce51194..2d2a1ccb5 100644 --- a/source/arche/tour_cpp.rst +++ b/source/arche/tour_cpp.rst @@ -1,8 +1,11 @@ A Tour of Cycstub ================= +Since |Cyclus| version 1.3.1 the Cycstub CLI is included in a standard |Cyclus| installation. +If you have an older version of |Cyclus| please refer to the `Cycstub repository `_ +for installation instructions. This section will walk through the source files of the stub :term:`archetypes -` in `Cycstub `_. Cycstub provides +` in Cycstub. Cycstub provides three stub archetypes: * ``StubFacility`` @@ -10,28 +13,7 @@ three stub archetypes: * ``StubRegion`` We will walk through ``StubFacility``\ 's source specifically because its the -most complicated of the three. Before we begin, though, let's get a fresh copy -of Cycstub (or follow along on the `website -`_). - -**Getting cycstub via git:** - -.. code-block:: bash - - $ git clone https://github.com/cyclus/cycstub.git - $ cd cycstub - -**Getting cycstub via zip:** - -.. code-block:: bash - - $ curl -L https://api.github.com/repos/cyclus/cycstub/zipball > cycstub.zip - $ unzip cycstub.zip - $ mv cyclus-cycstub-* cycstub - $ cd cycstub - -Feel free to ``rm`` the cycstub directory when we're done (you can always get it -back!). +most complicated of the three. StubFacility ------------ diff --git a/source/arche/tutorial_cpp/index.rst b/source/arche/tutorial_cpp/index.rst index 9b73e9bb0..4f33f0fa5 100644 --- a/source/arche/tutorial_cpp/index.rst +++ b/source/arche/tutorial_cpp/index.rst @@ -8,7 +8,7 @@ vocabulary of Cyclus. We also assume that the learner has a Github account. Overview --------- -Through this tutorial, we will transform a copy of the Cycstub repository into +Through this tutorial, we will use the Cycstub CLI to generate an open source Cyclus archetype module that includes an archetype to simulate a very simple interim storage facility, named "Storage". Ultimately, this facility will have the following characteristics, all definable by the user: