Skip to content

Commit 7c5aa8b

Browse files
Add intro to examples page
1 parent 676b731 commit 7c5aa8b

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/examples.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
Examples
22
========
33

4+
The following examples showcase the features of ``sectionproperties`` in an
5+
instructional manner, while also highlighting several validation tests and advanced
6+
applications. The below examples are available as jupyter notebooks and can be
7+
downloaded
8+
`here <https://github.com/robbievanleeuwen/section-properties/tree/master/docs/examples>`_
9+
(click on the file you would like to download, then click the download icon at the top
10+
of the file).
11+
12+
To run these notebooks you must first install `jupyter notebook <https://jupyter.org/>`_
13+
by running ``pip install notebook`` in the same virtual environment in which
14+
``sectionproperties`` is installed. Next, navigate to the location of the downloaded
15+
examples and run ``jupyter notebook`` to open jupyter in the browser. Finally, double
16+
click an example file to open the notebook, and execute each cell by clicking the play
17+
button. More information on jupyter notebooks can be found
18+
`here <https://docs.jupyter.org/en/latest/>`_. Don't be afraid to
19+
`raise an issue <https://github.com/robbievanleeuwen/section-properties/issues>`_ or
20+
`post in the discussions page <https://github.com/robbievanleeuwen/section-properties/discussions>`_
21+
if you have trouble running any of the examples!
22+
423
Geometry
524
--------
625

0 commit comments

Comments
 (0)