diff --git a/README.rst b/README.rst index 3a658181baa4fa8403b201b972b36a0e08fff57c..dc20d2bfa455fe7ff448630a49cd5cbcf0aafee7 100644 --- a/README.rst +++ b/README.rst @@ -56,6 +56,7 @@ Development versions are only available using the extra url: To install cuda and cdnn for GPU accellaration (requires nvidia drivers to be installed on your system), from version 0.31 you can use: .. code-block:: + pip install cmrsim[cuda] Docker diff --git a/docs/source/_static/api/overview_simulation.svg b/docs/source/_static/api/overview_simulation.svg index 9e96b639a4817843952927be97442d1ce27b714f..82c8df02f976c60cf864aae765a1cb1f95e6d768 100644 --- a/docs/source/_static/api/overview_simulation.svg +++ b/docs/source/_static/api/overview_simulation.svg @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:38dd98e89424fa688313ce16692835958646b971dd80961f7bc94ea67115b7e1 -size 1098868 +oid sha256:694143ca34dbe09c8682960f471af60e4ef200dc29dc4917fce9fb87a9f80ecb +size 1291058 diff --git a/docs/source/_static/notebook_thumbnails/static_GIRF_GRE.png b/docs/source/_static/notebook_thumbnails/static_GIRF_GRE.png new file mode 100644 index 0000000000000000000000000000000000000000..b4ccde10d7efdd5bda32feea0c97c54e357b1863 --- /dev/null +++ b/docs/source/_static/notebook_thumbnails/static_GIRF_GRE.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0362290efd82993769ed705a685135d60b64f1a6a0d9adf1ca4733101a86be0d +size 165785 diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst index 1fef2a06bf167f60ad5b4389157c3076ef075f83..9e9b31b9e0dac6b8169ef43ec33df19177a31a05 100644 --- a/docs/source/api/index.rst +++ b/docs/source/api/index.rst @@ -16,7 +16,7 @@ API reference .. card:: Overview of component-functionality: - .. image:: ../_static/api/overview_simulation.png + .. image:: ../_static/api/overview_simulation.svg .. card:: Overview of the CMRSIM package-components diff --git a/docs/source/conf.py b/docs/source/conf.py index ddef0f7b520eeca500369ea03c13705625bf1f43..c1b2ca55d5e4b6ea5776e1870cdb3913fe294a7e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -188,7 +188,7 @@ nbsphinx_thumbnails = { 'example_gallery/bloch_simulation/flow_venc_sGRE_turbUBend': '_static/notebook_thumbnails/bloch_flow_venc_sGRE_turbUBend.png', 'example_gallery/bloch_simulation/flow_venc_sGRE_stenosis_sequential': '_static/notebook_thumbnails/flow_bloch_sequential.svg', 'example_gallery/bloch_simulation/movmesh_bssfp': '_static/notebook_thumbnails/bloch_movemesh_bssfp.png', - 'example_gallery/bloch_simulation/static_GIRF_GRE': '_static_notebook_thumbnails/static_GIRF_GRE_thumbnail.png', + 'example_gallery/bloch_simulation/static_GIRF_GRE': '_static/notebook_thumbnails/static_GIRF_GRE.png', } def _setup_navbar_side_toctree(app: Any): diff --git a/docs/source/examples.rst b/docs/source/examples.rst index a550926a3031ba9d689c84f1cfdbaf422a1ed42e..dc94d252f1954eb7ab087ec5b8dfb4f2ad669571 100644 --- a/docs/source/examples.rst +++ b/docs/source/examples.rst @@ -20,6 +20,7 @@ Examples example_gallery/trajectory_modules/turbulent_flow example_gallery/trajectory_modules/taylor_trajectories example_gallery/trajectory_modules/cardiac_mesh_pod + example_gallery/trajectory_modules/breathing_motion_module example_gallery/trajectory_modules/contracting_cardiac_mesh_with_random_disp .. card:: @@ -32,6 +33,7 @@ Examples example_gallery/bloch_simulation/static_CPMG_t2star example_gallery/bloch_simulation/static_BSSFP_offresonance example_gallery/bloch_simulation/static_multi_coil_bssfp + example_gallery/bloch_simulation/static_GIRF_GRE .. nbgallery:: :caption: Bloch Simulations - Flowing Particles diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index 5b842fb74257fde07f2dd1f601334db7f077aa8f..edbadeca80ab0d481a36583562642b55473c6d86 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -24,6 +24,7 @@ Installation in command line: To install cuda and cdnn for GPU accellaration (requires nvidia drivers to be installed on your system), from version 0.31 you can use: .. code-block:: + pip install cmrsim[cuda]