Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add jupyter notebook instructions to Examples page #386

Merged
merged 1 commit into from Jan 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/examples.rst
@@ -1,6 +1,25 @@
Examples
========

The following examples showcase the features of ``sectionproperties`` in an
instructional manner, while also highlighting several validation tests and advanced
applications. The below examples are available as jupyter notebooks and can be
downloaded
`here <https://github.com/robbievanleeuwen/section-properties/tree/master/docs/examples>`_
(click on the file you would like to download, then click the download icon at the top
of the file).

To run these notebooks you must first install `jupyter notebook <https://jupyter.org/>`_
by running ``pip install notebook`` in the same virtual environment in which
``sectionproperties`` is installed. Next, navigate to the location of the downloaded
examples and run ``jupyter notebook`` to open jupyter in the browser. Finally, double
click an example file to open the notebook, and execute each cell by clicking the play
button. More information on jupyter notebooks can be found
`here <https://docs.jupyter.org/en/latest/>`_. Don't be afraid to
`raise an issue <https://github.com/robbievanleeuwen/section-properties/issues>`_ or
`post in the discussions page <https://github.com/robbievanleeuwen/section-properties/discussions>`_
if you have trouble running any of the examples!

Geometry
--------

Expand Down