Skip to content

Commit fdf81f4

Browse files
authored
Merge pull request enzo-project#112 from fearmayo/quickstart
[JOSS] Fixing the quickstart JOSS issue with the Collapse Test
2 parents 15b8577 + a11c438 commit fdf81f4

10 files changed

+50
-7
lines changed

doc/manual/source/user_guide/bootcamp.rst

+50-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Quickstart Guide to Enzo
22
========================
33

4-
This is an unofficial quickstart guide to using Enzo, starting from
4+
This is the quickstart guide to using Enzo, starting from
55
checking out the Enzo and YT sources, through to building them, then
66
to running an example problem and looking at its output.
77

@@ -10,7 +10,7 @@ useful information or useful tools:
1010

1111
* `github.com/enzo-project/enzo-dev <http://github.com/enzo-project/enzo-dev>`_
1212
* `yt-project.org <http://yt-project.org>`_
13-
* `jacques.enzotools.org <http://jacques.enzotools.org>`_
13+
1414

1515
If you ever get stuck, please email `enzo-users
1616
<https://groups.google.com/forum/#!forum/enzo-users>`_. This is not
@@ -21,7 +21,15 @@ interlocking modules, unusual combinations of parameters may require
2121
some care, and the individual developers that have created those
2222
modules will be able to discuss them with you.
2323

24-
24+
Getting YT
25+
------------
26+
YT was initially developed to allow fast and easy analysis of Enzo output. Since it's
27+
original inception YT has grown to be a powerful tool capable of analysing
28+
many different astrophysical simulation code outputs and also non-astro
29+
simulation outputs too.
30+
To get your hands on YT (which you will need to complete this quickstart tutorial)
31+
then go to the `YT installation page <https://yt-project.org/doc/installing.html>`_
32+
and install YT locally.
2533

2634
Getting Enzo
2735
------------
@@ -240,20 +248,55 @@ script, you should be able to execute this command:
240248

241249
This will take three slices through the center of the domain along
242250
each axis, as sliced through the very first output. The images will be
243-
saved to the subdirectory frames .
251+
saved to the subdirectory frames. Here is a plot of the outputs that can be
252+
expected from the DD0000 snapshots:
244253

245-
Now let's take a look at DD0010 :
254+
.. image:: ../../../../run/Hydro/Hydro-3D/CollapseTestNonCosmological/frames/DD0000_Slice_x_density.png
255+
:width: 30%
256+
246257

258+
.. image:: ../../../../run/Hydro/Hydro-3D/CollapseTestNonCosmological/frames/DD0000_Slice_y_density.png
259+
:width: 30%
247260

261+
.. image:: ../../../../run/Hydro/Hydro-3D/CollapseTestNonCosmological/frames/DD0000_Slice_z_density.png
262+
:width: 30%
263+
264+
265+
266+
267+
Now let's take a look at DD0010 :
268+
248269
::
249270

250271
$ yt plot DD0010/DD0010
251272

252273

274+
.. image:: ../../../../run/Hydro/Hydro-3D/CollapseTestNonCosmological/frames/DD0010_Slice_x_density.png
275+
:width: 30%
276+
277+
278+
.. image:: ../../../../run/Hydro/Hydro-3D/CollapseTestNonCosmological/frames/DD0010_Slice_y_density.png
279+
:width: 30%
280+
281+
.. image:: ../../../../run/Hydro/Hydro-3D/CollapseTestNonCosmological/frames/DD0010_Slice_z_density.png
282+
:width: 30%
283+
284+
253285
By this point the simulation has not collapsed very far. Feel free to
254-
check later outputs.
286+
check later outputs (e.g. the yt output from DD0070 shown below)
287+
288+
.. image:: ../../../../run/Hydro/Hydro-3D/CollapseTestNonCosmological/frames/DD0070_Slice_x_density.png
289+
:width: 30%
290+
291+
292+
.. image:: ../../../../run/Hydro/Hydro-3D/CollapseTestNonCosmological/frames/DD0070_Slice_y_density.png
293+
:width: 30%
294+
295+
.. image:: ../../../../run/Hydro/Hydro-3D/CollapseTestNonCosmological/frames/DD0070_Slice_z_density.png
296+
:width: 30%
297+
255298

256-
Another handy command is yt stats , which will describe the current
299+
Another handy command is yt stats, which will describe the current
257300
state of the simulation in a couple metrics.
258301

259302

Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)