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.

Sign up for GitHub

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

Jump to bottom

Docs update #206

Merged
merged 4 commits into from
Mar 9, 2022
Merged

Docs update #206

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f1a9c6b
update links
py1sl Mar 9, 2022
7f741d5
updated links to notebooks
py1sl Mar 9, 2022
f6a3003
fixed broken link
py1sl Mar 9, 2022
ae3719b
updated link to arc paper
shimwell Mar 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/source/example_parametric_components.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ Examples - Parametric Components
make_components_blankets.ipynb
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_components/make_components_blankets.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_components/make_components_blankets.ipynb>`__


make_components_center_column.ipynb
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_components/make_components_center_column.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_components/make_components_center_column.ipynb>`__

make_components_magnets.ipynb
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_components/make_components_center_column.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_components/make_components_center_column.ipynb>`__

make_components_other.ipynb
^^^^^^^^^^^^^^^^^^^^^^^^^^^

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_components/make_components_other.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_components/make_components_other.ipynb>`__


make_demo_style_blankets.ipynb
Expand All @@ -31,7 +31,7 @@ make_demo_style_blankets.ipynb
:height: 350
:align: center

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_components/make_demo_style_blankets.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_components/make_demo_style_blankets.ipynb>`__


make_firstwall_for_neutron_wall_loading.ipynb
Expand All @@ -42,7 +42,7 @@ make_firstwall_for_neutron_wall_loading.ipynb
:height: 807
:align: center

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_components/make_firstwall_for_neutron_wall_loading.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_components/make_firstwall_for_neutron_wall_loading.ipynb>`__


make_magnet_set.ipynb
Expand All @@ -52,7 +52,7 @@ make_magnet_set.ipynb
:width: 500
:align: center

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_components/make_magnet_set.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_components/make_magnet_set.ipynb>`__


make_plasmas.ipynb
Expand All @@ -63,16 +63,16 @@ make_plasmas.ipynb
:height: 700
:align: center

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_components/make_plasmas.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_components/make_plasmas.ipynb>`__


make_vacuum_vessel_with_ports.ipynb
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_components/make_vacuum_vessel_with_ports.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_components/make_vacuum_vessel_with_ports.ipynb>`__


make_varible_offset_firstwall.ipynb
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_components/make_varible_offset_firstwall.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_components/make_varible_offset_firstwall.ipynb>`__
20 changes: 10 additions & 10 deletions docs/source/example_parametric_reactors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ ball_reactor.ipynb

cadquery_object = my_reactor.solid

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_reactors/ball_reactor.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_reactors/ball_reactor.ipynb>`__


ball_reactor_single_null.ipynb
Expand Down Expand Up @@ -105,7 +105,7 @@ ball_reactor_single_null.ipynb

cadquery_object = my_reactor.solid

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_reactors/ball_reactor_single_null.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_reactors/ball_reactor_single_null.ipynb>`__


center_column_study_reactor.ipynb
Expand Down Expand Up @@ -136,7 +136,7 @@ center_column_study_reactor.ipynb

cadquery_object = my_reactor.solid

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_reactors/center_column_study_reactor.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_reactors/center_column_study_reactor.ipynb>`__

eu_demo_from_2015_paper.ipynb
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -154,7 +154,7 @@ eu_demo_from_2015_paper.ipynb

cadquery_object = my_reactor.solid

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_reactors/eu_demo_from_2015_paper.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_reactors/eu_demo_from_2015_paper.ipynb>`__


make_animation.ipynb
Expand All @@ -168,7 +168,7 @@ make_animation.ipynb
.. |animation2| image:: https://user-images.githubusercontent.com/8583900/107030664-e2131480-67a8-11eb-84bb-59656e9e7722.gif
:width: 300

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_reactors/submersion_reactor.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_reactors/submersion_reactor.ipynb>`__


segmented_blanket_ball_reactor.ipynb
Expand Down Expand Up @@ -211,7 +211,7 @@ segmented_blanket_ball_reactor.ipynb

cadquery_object = my_reactor.solid

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_reactors/segmented_blanket_ball_reactor.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_reactors/segmented_blanket_ball_reactor.ipynb>`__

sparc_from_2020_paper.ipynb
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -228,7 +228,7 @@ sparc_from_2020_paper.ipynb

cadquery_object = my_reactor.solid

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_reactors/sparc_from_2020_paper.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_reactors/sparc_from_2020_paper.ipynb>`__


submersion_reactor.ipynb
Expand Down Expand Up @@ -268,7 +268,7 @@ submersion_reactor.ipynb
)
cadquery_object = my_reactor.solid

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_reactors/submersion_reactor.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_reactors/submersion_reactor.ipynb>`__


submersion_reactor_single_null.ipynb
Expand Down Expand Up @@ -311,7 +311,7 @@ submersion_reactor_single_null.ipynb

cadquery_object = my_reactor.solid

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_reactors/submersion_reactor_single_null.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_reactors/submersion_reactor_single_null.ipynb>`__


iter_from_2020_paper.ipynb
Expand All @@ -329,4 +329,4 @@ iter_from_2020_paper.ipynb

cadquery_object = my_reactor.solid

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_reactors/iter_from_2020_paper_diagram.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_reactors/iter_from_2020_paper.ipynb>`__
12 changes: 6 additions & 6 deletions docs/source/example_parametric_shapes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ make_CAD_from_points.ipynb
:height: 275
:align: center

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_shapes/make_CAD_from_points.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_shapes/make_CAD_from_points.ipynb>`__


make_blanket_from_parameters.ipynb
Expand All @@ -20,7 +20,7 @@ make_blanket_from_parameters.ipynb
:height: 400
:align: center

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_shapes/make_blanket_from_parameters.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_shapes/make_blanket_from_parameters.ipynb>`__


make_blanket_from_points.ipynb
Expand All @@ -31,7 +31,7 @@ make_blanket_from_points.ipynb
:height: 400
:align: center

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_shapes/make_blanket_from_points.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_shapes/make_blanket_from_points.ipynb>`__


make_can_reactor_from_parameters.ipynb
Expand All @@ -42,7 +42,7 @@ make_can_reactor_from_parameters.ipynb
:height: 450
:align: center

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_shapes/make_can_reactor_from_parameters.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_shapes/make_can_reactor_from_parameters.ipynb>`__


make_can_reactor_from_points.ipynb
Expand All @@ -53,7 +53,7 @@ make_can_reactor_from_points.ipynb
:height: 450
:align: center

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_shapes/make_can_reactor_from_points.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_shapes/make_can_reactor_from_points.ipynb>`__


make_html_diagram_from_stp_file.ipynb
Expand All @@ -62,5 +62,5 @@ make_html_diagram_from_stp_file.ipynb
.. image:: https://user-images.githubusercontent.com/8583900/117488160-fb705c00-af63-11eb-882e-27e284ceb79f.png
:align: center

`Link to notebook <https://github.com/ukaea/paramak/blob/develop/examples/example_parametric_shapes/make_html_diagram_from_stp_file.ipynb>`__
`Link to notebook <https://github.com/fusion-energy/paramak/blob/develop/examples/example_parametric_shapes/make_html_diagram_from_stp_file.ipynb>`__

8 changes: 4 additions & 4 deletions docs/source/tests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@ Similarly, the examples notebooks may be tested by calling:
pytest examples_tests

The status of the tests is available on the CircleCI account
`CircleCI account. <https://app.circleci.com/pipelines/github/ukaea/paramak?branch=main>`_
`CircleCI account. <https://app.circleci.com/pipelines/github/fusion-energy/paramak?branch=main>`_

The test suite can be explored on the
`Gihub source code repository. <https://github.com/ukaea/paramak/tree/main/tests>`_
`Gihub source code repository. <https://github.com/fusion-energy/paramak/tree/main/tests>`_

In addition to automated tests we also have automated code style formatting
using `autopep8 and Github Actions. <https://github.com/ukaea/paramak/actions?query=workflow%3Aautopep8>`_
using `autopep8 and Github Actions. <https://github.com/fusion-energy/paramak/actions?query=workflow%3Aautopep8>`_

Continuing the theme of automation we also have automated distribution updates.
The distribution is performed by `PyPI <https://pypi.org/>`_ and this is kept
up to date using Github Actions
`(upload python package) <https://github.com/ukaea/paramak/actions?query=workflow%3A%22Upload+Python+Package%22>`_
`(upload python package) <https://github.com/fusion-energy/paramak/actions?query=workflow%3A%22Upload+Python+Package%22>`_
which trigger on every merge to the main branch.

There are also plans for a continuously updated Dockerhub image in the pipeline.