Skip to content

Commit fa14f96

Browse files
committed
Replace Finder image with 'tree' output to show final directory structure
This hopefully makes the result clearer and removes a binary file from the repo. [skip-ci]
1 parent 98cf829 commit fa14f96

File tree

2 files changed

+86
-9
lines changed

2 files changed

+86
-9
lines changed
-181 KB
Binary file not shown.

docs/source/example-c.rst

Lines changed: 86 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,91 @@ create a directory to hold our work:
2727
mkdir example-c && cd example-c
2828
2929
This directory is a starting point;
30-
we'll make new directories under it as we proceed through the example.
31-
In the end,
32-
the directory structure under ``example-c`` should look like that in Figure 1.
30+
we'll add files and directories to it as we proceed through the example.
31+
At the end,
32+
the directory structure under ``example-c`` should look similar to that below.
3333

34-
.. figure:: _static/babelizer-bmi-example-c.png
35-
:align: center
36-
:alt: Directory structure after completing example
34+
.. code:: bash
35+
36+
example-c
37+
├── babel_heatc.toml
38+
├── bmi-example-c
39+
│   ├── CMakeLists.txt
40+
│   ├── LICENSE
41+
│   ├── README.md
42+
│   ├── heat
43+
│   │   ├── CMakeLists.txt
44+
│   │   ├── bmi_heat.c
45+
│   │   ├── bmi_heat.h
46+
│   │   ├── bmi_main.c
47+
│   │   ├── bmiheatc.pc.cmake
48+
│   │   ├── heat.c
49+
│   │   ├── heat.h
50+
│   │   ├── heatc.pc.cmake
51+
│   │   └── main.c
52+
│   └── testing
53+
│   ├── CMakeLists.txt
54+
│   ├── config.txt
55+
│   ├── test_conflicting_instances.c
56+
│   ├── test_get_value.c
57+
│   ├── test_grid_info.c
58+
│   ├── test_initialize_from_file.c
59+
│   ├── test_irf.c
60+
│   ├── test_print_var_names.c
61+
│   ├── test_reinitialize.c
62+
│   └── test_set_value.c
63+
├── environment-c.yml
64+
├── pymt_heatc
65+
│   ├── CHANGES.rst
66+
│   ├── CREDITS.rst
67+
│   ├── LICENSE.rst
68+
│   ├── MANIFEST.in
69+
│   ├── README.rst
70+
│   ├── babel.toml
71+
│   ├── build
72+
│   │   └── HeatC
73+
│   │   └── api.yaml
74+
│   ├── docs
75+
│   │   ├── Makefile
76+
│   │   ├── _static
77+
│   │   │   ├── logo-dark.svg
78+
│   │   │   └── logo-light.svg
79+
│   │   ├── api
80+
│   │   ├── authors.rst
81+
│   │   ├── babel.rst
82+
│   │   ├── changelog.rst
83+
│   │   ├── conf.py
84+
│   │   ├── developer_install.rst
85+
│   │   ├── environments.rst
86+
│   │   ├── index.rst
87+
│   │   ├── license.rst
88+
│   │   ├── quickstart.rst
89+
│   │   ├── updating.rst
90+
│   │   └── usage.rst
91+
│   ├── meson.build
92+
│   ├── meta
93+
│   │   └── HeatC
94+
│   │   └── api.yaml
95+
│   ├── noxfile.py
96+
│   ├── pymt_heatc
97+
│   │   ├── __init__.py
98+
│   │   ├── _bmi.py
99+
│   │   ├── _version.py
100+
│   │   ├── data -> ../meta
101+
│   │   └── lib
102+
│   │   ├── __init__.py
103+
│   │   └── heatc.pyx
104+
│   ├── pyproject.toml
105+
│   ├── requirements-build.txt
106+
│   ├── requirements-library.txt
107+
│   ├── requirements-testing.txt
108+
│   ├── requirements.txt
109+
│   └── setup.cfg
110+
└── test
111+
└── config.txt
112+
113+
16 directories, 60 files
37114
38-
Figure 1: Directory structure after completing the C example.
39115
40116
Set up a conda environment
41117
--------------------------
@@ -171,13 +247,14 @@ Build and install the wrapped model
171247
...................................
172248

173249
Change to the ``pymt_heatc`` directory,
174-
then build and install the Python package with:
250+
then build and install the Python package with *pip*:
175251

176252
.. code:: bash
177253
254+
cd pymt_heatc
178255
pip install ."[dev]"
179256
180-
This command sets off a long list of messages,
257+
The ``pip install`` command sets off a long list of messages,
181258
at the end of which you'll hopefully see:
182259

183260
.. code:: bash

0 commit comments

Comments
 (0)