Skip to content

Commit

Permalink
Merge pull request #386 from bennibbelink/cycstub-update
Browse files Browse the repository at this point in the history
Update cycstub installation instructions
  • Loading branch information
gonuke authored Sep 13, 2024
2 parents 9958e61 + 52a4393 commit a4c6fd5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 24 deletions.
28 changes: 5 additions & 23 deletions source/arche/tour_cpp.rst
Original file line number Diff line number Diff line change
@@ -1,37 +1,19 @@
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 <https://github.com/cyclus/cycstub>`_
for installation instructions.
This section will walk through the source files of the stub :term:`archetypes
<archetype>` in `Cycstub <https://github.com/cyclus/cycstub>`_. Cycstub provides
<archetype>` in Cycstub. Cycstub provides
three stub archetypes:

* ``StubFacility``
* ``StubInstitution``
* ``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
<https://github.com/cyclus/cycstub>`_).

**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
------------
Expand Down
2 changes: 1 addition & 1 deletion source/arche/tutorial_cpp/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit a4c6fd5

Please sign in to comment.