Skip to content

Commit e1238b7

Browse files
committed
update code-block types for highlighting
1 parent 6ad43cf commit e1238b7

19 files changed

+58
-58
lines changed

source/arche/cli.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ single-string form ``spec`` (e.g. ``:cycamore:Source``) which is discussed
1313
To view the auto-generated XML schema used for validating archetype
1414
configuration parameters in input files:
1515

16-
.. code-block:: bash
16+
.. code-block:: console
1717
1818
$ cyclus --agent-schema :agents:Source
1919
<interleave>
@@ -33,7 +33,7 @@ configuration parameters in input files:
3333
To view a JSON structured output of all the data generated and collected from
3434
``#pragma cyclus`` annotations for a particular archetype:
3535

36-
.. code-block:: bash
36+
.. code-block:: console
3737
3838
$ cyclus --agent-annotations :cycamore:Source
3939
{
@@ -52,7 +52,7 @@ To view a JSON structured output of all the data generated and collected from
5252
5353
And to list all archetypes inside a particular library:
5454

55-
.. code-block:: bash
55+
.. code-block:: console
5656
5757
$ cyclus --agent-listing :cycamore
5858
:cycamore:DeployInst
@@ -71,7 +71,7 @@ Archetype Versioning
7171
The ``cyclus::Agent`` class exposes a ``version()`` member function which can be
7272
queried with the |Cyclus| CLI. For example,
7373

74-
.. code-block:: bash
74+
.. code-block:: console
7575
7676
$ cyclus --agent-version :agents:Source
7777
1.3.1-7-g9a2c9c9
@@ -94,7 +94,7 @@ your own version tag information for some archetype like
9494
9595
and then access the version with
9696

97-
.. code-block:: bash
97+
.. code-block:: console
9898
9999
$ cyclus --agent-version my/path:my_library:MyArchetype
100100
My Version

source/arche/cmake.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The ``UseCyclus.cmake`` macro suite uses the following terms:
6767
``$CYCLUS_INSTALL_PREFIX/lib/cyclus/my_module_dir/``. The value of
6868
``$CYCLUS_INSTALL_PREFIX`` can be queried by
6969

70-
.. code-block:: bash
70+
.. code-block:: console
7171
7272
$ cyclus --install-path
7373

source/arche/errors.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ suppress all warnings and a very large number will print them all. For
132132
example, if the user wished to print the first 42 warnings of each kind they
133133
would call |cyclus| as follows:
134134

135-
.. code-block:: bash
135+
.. code-block:: console
136136
137137
$ cyclus --warn-limit 42 ...
138138
@@ -142,7 +142,7 @@ and throws the error. This is useful for ensuring that only stable code is
142142
executed or to help uncover what is causing a warning to be thrown. It takes
143143
no arguments:
144144

145-
.. code-block:: bash
145+
.. code-block:: console
146146
147147
$ cyclus --warn-as-error ...
148148

source/arche/hello_world_cpp.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ available wherever ``cyclus`` is available.
1414
To use ``cycstub`` to generate the skeleton for a new Facility archetype named ``TutorialFacility`` in
1515
a module named ``TutorialLibrary`` you can issue the following command:
1616

17-
.. code-block:: bash
17+
.. code-block:: console
1818
1919
tutorial $ cycstub --type facility tutorial:TutorialLibrary:TutorialFacility
2020
@@ -24,7 +24,7 @@ will not do anything, but will be a valid archetype for use in a simulation.
2424

2525
You can add additional agents to this module by calling `cycstub` multiple times:
2626

27-
.. code-block:: bash
27+
.. code-block:: console
2828
2929
tutorial $ cycstub --type inst tutorial:TutorialLibrary:TutorialInstitution
3030
tutorial $ cycstub --type region tutorial:TutorialLibrary:TutorialRegion
@@ -60,7 +60,7 @@ install the ``tutorial`` project. This done with the install.py script.
6060
The install script puts the project into your cyclus userspace,
6161
``${HOME}/.local/lib/cyclus``.
6262

63-
.. code-block:: bash
63+
.. code-block:: console
6464
6565
tutorial $ python3 install.py
6666
@@ -70,7 +70,7 @@ Let's run |cyclus| with the TutorialFacility! In the input directory there is
7070
an :file:`example_tutorial_facility.xml`. Running |cyclus| on this file with the command
7171
``cyclus example_tutorial_facility.xml`` should produce the following output.
7272

73-
.. code-block:: bash
73+
.. code-block:: console
7474
7575
tutorial $ cyclus example_tutorial_facility.xml
7676
:

source/arche/hello_world_py.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ an :file:`example.xml`. First modify it to point to the archetype we just wrote.
7171
Running |cyclus| on this file with the command
7272
``cyclus input/example.xml`` should produce the following output.
7373

74-
.. code-block:: bash
74+
.. code-block:: console
7575
7676
tutorial $ cyclus input/example.xml
7777
:

source/arche/logger.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Logging
44
=======================
55

6-
.. code-block:: bash
6+
.. code-block:: console
77
88
LOG(LogLevel level, std::string prefix)
99

source/arche/testing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ haven't already, now is a good time to add the ``$CYCLUS_INSTALL_PATH`` to your
174174
``~/.local``). Next, from your top level directory (where your ``install.py``
175175
file is), run:
176176

177-
.. code-block:: bash
177+
.. code-block:: console
178178
179179
$ ./install.py
180180
$ TickTracker_unit_tests
@@ -322,7 +322,7 @@ This will prevent exceptions from being caught resulting in a core-dump. You
322322
can then use a debugger (e.g. gdb or lldb) to run the failing simulation and
323323
investigate the source of the crash in more detail. Something like this:
324324

325-
.. code-block:: bash
325+
.. code-block:: console
326326
327327
$ CYCLUS_NO_CATCH=1 gdb --args cyclus my-failing-sim.xml
328328
@@ -339,7 +339,7 @@ with respect to resource exchange. To turn on this debugging, simply run
339339
cyclus with the environment variable ``CYCLUS_DEBUG_DRE`` set to any non-empty
340340
value:
341341

342-
.. code-block:: bash
342+
.. code-block:: console
343343
344344
$ CYCLUS_DEBUG_DRE=1 cyclus my-sim.xml
345345

source/arche/tour_cpp.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This section will walk through the source files of the stub :term:`archetypes
88
can generate stubs for each of the agent types. The standard usage to generate the
99
stubs for a Facility, Institution or Region, respectively, is:
1010

11-
.. code-block:: bash
11+
.. code-block:: console
1212
1313
cycstub --type facility :stublibrary:StubFacility
1414
cycstub --type institution :stublibrary:StubInstitution

source/cep/cep3.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Release Process
142142

143143
- make sure to have your ``rs.cred`` file (see ``maintenance.sh``'s help)
144144

145-
.. code-block:: bash
145+
.. code-block:: console
146146
147147
$ cd /path/to/release/utils
148148
$ export CYCLUS_DIR=/path/to/cyclus
@@ -163,7 +163,7 @@ Release Process
163163
#. if the dev-list agrees to those changes, update the symbols and
164164
commit the new one:
165165

166-
.. code-block:: bash
166+
.. code-block:: console
167167
168168
$ cd $CYCLUS_DIR/release
169169
$ ./smbchk.py --update -t X.X.X # X.X.X is *this* version
@@ -173,15 +173,15 @@ Release Process
173173
174174
#. Commit all changes for all projects.
175175

176-
.. code-block:: bash
176+
.. code-block:: console
177177
178178
$ cd /path/to/project
179179
$ git checkout vX.X.X-release
180180
$ git commit -am "final release commit after maintenence"
181181
182182
#. Update all master branches.
183183

184-
.. code-block:: bash
184+
.. code-block:: console
185185
186186
$ cd /path/to/project
187187
$ git checkout master
@@ -190,7 +190,7 @@ Release Process
190190
191191
#. *Locally* tag the repository for *each* of the projects.
192192

193-
.. code-block:: bash
193+
.. code-block:: console
194194
195195
$ cd /path/to/project
196196
$ git checkout master
@@ -202,7 +202,7 @@ Release Process
202202
- the ``make_release_notes.sh`` utility in ``release/utils`` will help
203203
provide a template
204204

205-
.. code-block:: bash
205+
.. code-block:: console
206206
207207
$ cd /path/to/release/utils
208208
$ export CYCLUS_DIR=/path/to/cyclus
@@ -218,7 +218,7 @@ Release Process
218218
- the ``api_docs.sh`` utility in ``release/utils`` will do this
219219
automatically for you
220220

221-
.. code-block:: bash
221+
.. code-block:: console
222222
223223
$ cd /path/to/release/utils
224224
$ export CYCLUS_DIR=/path/to/cyclus
@@ -227,7 +227,7 @@ Release Process
227227
228228
#. Update the ``master`` branch of all projects and clean up.
229229

230-
.. code-block:: bash
230+
.. code-block:: console
231231
232232
$ cd /path/to/project
233233
$ git push upstream X.X.X master
@@ -293,7 +293,7 @@ Release Process
293293
have to be compiled on you system and both executable and lib have to be on
294294
the default paths. Please refer to the :doc:`source installation
295295
<../user/install_from_git>` if you need.
296-
.. .. code-block:: bash
296+
.. .. code-block:: console
297297
$ git clone https://github.com/rwcarlsen/cloudlus.git
298298
$ cd cloudlus
299299
$ go install ./cmd/cloudlus
@@ -327,7 +327,7 @@ evolves, we'll want to have our version evolve as well. Here are the steps to do
327327
These assume that in your HOME dir there are both the pyne and |cyclus| repos. Remember
328328
to check in the changes afterwards.
329329

330-
.. code-block:: bash
330+
.. code-block:: console
331331
332332
$ cd ~/pyne
333333
$ ./amalgamate.py -s pyne.cc -i pyne.h
@@ -337,7 +337,7 @@ to check in the changes afterwards.
337337
our source data. Occassionally, this needs to be updated as updates to pyne itself come out.
338338
The command for generating |cyclus| specific nuclear data is as follows:
339339

340-
.. code-block:: bash
340+
.. code-block:: console
341341
342342
$ cd ~/pyne
343343
$ nuc_data_make -o cyclus_nuc_data.h5 \
@@ -357,7 +357,7 @@ automatically. In order to check this correctly, you must have a **RELEASE**
357357
build of Cyclus compiled/installed. Every release please run the following
358358
command to verify that the release branch is stable:
359359

360-
.. code-block:: bash
360+
.. code-block:: console
361361
362362
$ cd cyclus/release
363363
$ ./smbchk.py --update -t HEAD --no-save --check
@@ -374,7 +374,7 @@ Once stable and there are no more code changes to be made, add the symbols
374374
in this release to the database with the following command (again - make sure
375375
you are working on a RELEASE build of Cyclus):
376376

377-
.. code-block:: bash
377+
.. code-block:: console
378378
379379
$ cd cyclus/release
380380
$ ./smbchk.py --update -t X.X.X

source/user/cymetric/tutorial_cli.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Since cymetric is wholly dependent on |cyclus| databases, you must supply a
2828
database as an argument on the command line. This will look something like the
2929
following:
3030

31-
.. code-block:: bash
31+
.. code-block:: console
3232
3333
$ cymetric database -flags
3434
@@ -46,7 +46,7 @@ database. Note that this may list more tables in the database than are
4646
strictly part of the |cyclus| interface, because of the need for |cyclus| to
4747
store metadata. Don't be alarmed. Listing the current tables is easy:
4848

49-
.. code-block:: bash
49+
.. code-block:: console
5050
5151
$ cymetric test.h5 -l
5252
AgentEntry
@@ -90,7 +90,7 @@ can use. Indexing the table variables will return the metric as a `pandas
9090
``AgentEntry`` table, we would write ``AgentEntry[:]`` to get the table and
9191
``print(AgentEntry[:])`` to display it after the ``-e`` flag:
9292

93-
.. code-block:: bash
93+
.. code-block:: console
9494
9595
$ cymetric test.h5 -e "print(AgentEntry[:])"
9696
SimId AgentId Kind Spec Prototype ParentId Lifetime EnterTime
@@ -109,7 +109,7 @@ Indexing a metric with an empty slice (``[:]``), none (``[None]``), or an ellips
109109
filters on the column names. The column names of the metric are thus also available for
110110
use. For example, let's just grab all of the facilities out of the entry table:
111111

112-
.. code-block:: bash
112+
.. code-block:: console
113113
114114
$ cymetric test.h5 -e "print(AgentEntry[Kind == 'Facility'])"
115115
SimId AgentId Kind Spec Prototype ParentId Lifetime EnterTime
@@ -124,7 +124,7 @@ use. For example, let's just grab all of the facilities out of the entry table:
124124
Separate the conditions by commas (``,``) to apply multiple filters at the same
125125
time:
126126

127-
.. code-block:: bash
127+
.. code-block:: console
128128
129129
$ cymetric test.h5 -e "print(AgentEntry[Kind == 'Facility', AgentId > 14])"
130130
SimId AgentId Kind Spec Prototype ParentId Lifetime EnterTime
@@ -139,7 +139,7 @@ able to do in Python. Suppose that we have a ``Materials`` metric with a ``Mass`
139139
column. We can compute this metric, pull the column out, multiply it by 42,
140140
save the result to a variable, and then print this variable all via the following.
141141

142-
.. code-block:: bash
142+
.. code-block:: console
143143
144144
$ cymetric test.h5 -e "mass = Materials[:]['Mass'] * 42; print(mass)"
145145
0 0.000000
@@ -192,7 +192,7 @@ Module Alias
192192
This let's you do neat things such as plot the metrics right from the command line.
193193
For example,
194194

195-
.. code-block:: bash
195+
.. code-block:: console
196196
197197
$ cymetric test.h5 -e "Materials[ResourceId == 15].plot(x='NucId', y='Mass', kind='bar'); plt.show()"
198198
@@ -210,15 +210,15 @@ default functionality when you use the ``-e`` flag, the lack of writing
210210
can be accomplished with the ``--no-write`` flag. In the example below, the
211211
table will not be written to the database:
212212

213-
.. code-block:: bash
213+
.. code-block:: console
214214
215215
$ cymetric test.h5 --no-write -e "Materials[:]"
216216
217217
Since cymetric looks up an already evaluated metric in the database,
218218
overwriting an existing table with a new one might be desired. This is where
219219
the ``--write`` flag is useful:
220220

221-
.. code-block:: bash
221+
.. code-block:: console
222222
223223
$ cymetric test.h5 --write -e "Materials[:]"
224224

0 commit comments

Comments
 (0)