deploy: 781920e

brainglobe · Aug 24, 2023 · c3739a8 · c3739a8
1 parent ca4e319
commit c3739a8
Show file tree

Hide file tree

Showing 187 changed files with 1,902 additions and 1,099 deletions.
diff --git a/.doctrees/about.doctree b/.doctrees/about.doctree
diff --git a/.doctrees/contact.doctree b/.doctrees/contact.doctree
diff --git a/.doctrees/contributors.doctree b/.doctrees/contributors.doctree
diff --git a/.doctrees/developers/conventions.doctree b/.doctrees/developers/conventions.doctree
diff --git a/.doctrees/developers/index.doctree b/.doctrees/developers/index.doctree
diff --git a/.doctrees/developers/new_releases.doctree b/.doctrees/developers/new_releases.doctree
diff --git a/.doctrees/developers/repositories/cellfinder-core/cell-detection.doctree b/.doctrees/developers/repositories/cellfinder-core/cell-detection.doctree
diff --git a/.doctrees/developers/repositories/cellfinder-core/index.doctree b/.doctrees/developers/repositories/cellfinder-core/index.doctree
diff --git a/.doctrees/developers/repositories/cellfinder/index.doctree b/.doctrees/developers/repositories/cellfinder/index.doctree
diff --git a/.doctrees/developers/testing.doctree b/.doctrees/developers/testing.doctree
diff --git a/.doctrees/developers/tooling.doctree b/.doctrees/developers/tooling.doctree
diff --git a/.doctrees/documentation/bg-atlasapi/adding-a-new-atlas.doctree b/.doctrees/documentation/bg-atlasapi/adding-a-new-atlas.doctree
diff --git a/.doctrees/documentation/bg-atlasapi/index.doctree b/.doctrees/documentation/bg-atlasapi/index.doctree
diff --git a/.doctrees/documentation/bg-atlasapi/usage/atlas-details.doctree b/.doctrees/documentation/bg-atlasapi/usage/atlas-details.doctree
diff --git a/.doctrees/documentation/bg-atlasapi/usage/command-line-interface.doctree b/.doctrees/documentation/bg-atlasapi/usage/command-line-interface.doctree
diff --git a/.doctrees/documentation/bg-atlasapi/usage/python-api.doctree b/.doctrees/documentation/bg-atlasapi/usage/python-api.doctree
diff --git a/.doctrees/documentation/bg-atlasapi/usage/using-the-files-directly.doctree b/.doctrees/documentation/bg-atlasapi/usage/using-the-files-directly.doctree
diff --git a/.doctrees/documentation/bg-space/index.doctree b/.doctrees/documentation/bg-space/index.doctree
diff --git a/.doctrees/documentation/brainreg-segment/index.doctree b/.doctrees/documentation/brainreg-segment/index.doctree
diff --git a/.doctrees/documentation/brainreg-segment/user-guide/analysing-external-segmentation.doctree b/.doctrees/documentation/brainreg-segment/user-guide/analysing-external-segmentation.doctree
diff --git a/.doctrees/documentation/brainreg-segment/user-guide/index.doctree b/.doctrees/documentation/brainreg-segment/user-guide/index.doctree
diff --git a/.doctrees/documentation/brainreg-segment/user-guide/segmenting-1d-tracks.doctree b/.doctrees/documentation/brainreg-segment/user-guide/segmenting-1d-tracks.doctree
diff --git a/.doctrees/documentation/brainreg-segment/user-guide/segmenting-3d-structures.doctree b/.doctrees/documentation/brainreg-segment/user-guide/segmenting-3d-structures.doctree
diff --git a/.doctrees/documentation/brainreg/index.doctree b/.doctrees/documentation/brainreg/index.doctree
diff --git a/.doctrees/documentation/brainreg/installation.doctree b/.doctrees/documentation/brainreg/installation.doctree
diff --git a/.doctrees/documentation/brainreg/troubleshooting.doctree b/.doctrees/documentation/brainreg/troubleshooting.doctree
diff --git a/.doctrees/documentation/brainreg/user-guide/brainreg-cli.doctree b/.doctrees/documentation/brainreg/user-guide/brainreg-cli.doctree
diff --git a/.doctrees/documentation/brainreg/user-guide/brainreg-napari.doctree b/.doctrees/documentation/brainreg/user-guide/brainreg-napari.doctree
diff --git a/.doctrees/documentation/brainreg/user-guide/checking-orientation.doctree b/.doctrees/documentation/brainreg/user-guide/checking-orientation.doctree
diff --git a/.doctrees/documentation/brainreg/user-guide/output-files.doctree b/.doctrees/documentation/brainreg/user-guide/output-files.doctree
diff --git a/.doctrees/documentation/brainreg/user-guide/parameters.doctree b/.doctrees/documentation/brainreg/user-guide/parameters.doctree
diff --git a/.doctrees/documentation/brainreg/user-guide/visualisation.doctree b/.doctrees/documentation/brainreg/user-guide/visualisation.doctree
diff --git a/.doctrees/documentation/brainrender/index.doctree b/.doctrees/documentation/brainrender/index.doctree
diff --git a/.doctrees/documentation/brainrender/installation.doctree b/.doctrees/documentation/brainrender/installation.doctree
diff --git a/.doctrees/documentation/brainrender/usage/actors.doctree b/.doctrees/documentation/brainrender/usage/actors.doctree
diff --git a/.doctrees/documentation/brainrender/usage/index.doctree b/.doctrees/documentation/brainrender/usage/index.doctree
diff --git a/.doctrees/documentation/brainrender/usage/scene.doctree b/.doctrees/documentation/brainrender/usage/scene.doctree
diff --git a/.doctrees/documentation/brainrender/usage/using-notebooks.doctree b/.doctrees/documentation/brainrender/usage/using-notebooks.doctree
diff --git a/.doctrees/documentation/brainrender/usage/using-your-data/index.doctree b/.doctrees/documentation/brainrender/usage/using-your-data/index.doctree
diff --git a/.doctrees/documentation/brainrender/usage/using-your-data/registering-data.doctree b/.doctrees/documentation/brainrender/usage/using-your-data/registering-data.doctree
diff --git a/.doctrees/documentation/brainrender/usage/videos-animations-and-exporting-to-html.doctree b/.doctrees/documentation/brainrender/usage/videos-animations-and-exporting-to-html.doctree
diff --git a/.doctrees/documentation/cellfinder/index.doctree b/.doctrees/documentation/cellfinder/index.doctree
diff --git a/.doctrees/documentation/cellfinder/installation.doctree b/.doctrees/documentation/cellfinder/installation.doctree
diff --git a/.doctrees/documentation/cellfinder/troubleshooting/error-messages.doctree b/.doctrees/documentation/cellfinder/troubleshooting/error-messages.doctree
diff --git a/.doctrees/documentation/cellfinder/troubleshooting/index.doctree b/.doctrees/documentation/cellfinder/troubleshooting/index.doctree
diff --git a/.doctrees/documentation/cellfinder/troubleshooting/speed-up.doctree b/.doctrees/documentation/cellfinder/troubleshooting/speed-up.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/cellfinder-core.doctree b/.doctrees/documentation/cellfinder/user-guide/cellfinder-core.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/command-line/candidate-detection.doctree b/.doctrees/documentation/cellfinder/user-guide/command-line/candidate-detection.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/command-line/classification.doctree b/.doctrees/documentation/cellfinder/user-guide/command-line/classification.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/command-line/cli.doctree b/.doctrees/documentation/cellfinder/user-guide/command-line/cli.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/command-line/data-requirements.doctree b/.doctrees/documentation/cellfinder/user-guide/command-line/data-requirements.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/command-line/docker.doctree b/.doctrees/documentation/cellfinder/user-guide/command-line/docker.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/command-line/index.doctree b/.doctrees/documentation/cellfinder/user-guide/command-line/index.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/command-line/output-files.doctree b/.doctrees/documentation/cellfinder/user-guide/command-line/output-files.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/command-line/training/index.doctree b/.doctrees/documentation/cellfinder/user-guide/command-line/training/index.doctree
diff --git a/...ees/documentation/cellfinder/user-guide/command-line/training/using-supplied-data.doctree b/...ees/documentation/cellfinder/user-guide/command-line/training/using-supplied-data.doctree
diff --git a/...rees/documentation/cellfinder/user-guide/command-line/using-cellfinder-at-the-swc.doctree b/...rees/documentation/cellfinder/user-guide/command-line/using-cellfinder-at-the-swc.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/command-line/visualisation.doctree b/.doctrees/documentation/cellfinder/user-guide/command-line/visualisation.doctree
diff --git a/...s/documentation/cellfinder/user-guide/napari-plugin/all-cell-detection-parameters.doctree b/...s/documentation/cellfinder/user-guide/napari-plugin/all-cell-detection-parameters.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/napari-plugin/cell-detection.doctree b/.doctrees/documentation/cellfinder/user-guide/napari-plugin/cell-detection.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/napari-plugin/index.doctree b/.doctrees/documentation/cellfinder/user-guide/napari-plugin/index.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/napari-plugin/training-data-generation.doctree b/.doctrees/documentation/cellfinder/user-guide/napari-plugin/training-data-generation.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/napari-plugin/training-the-network.doctree b/.doctrees/documentation/cellfinder/user-guide/napari-plugin/training-the-network.doctree
diff --git a/.doctrees/documentation/cellfinder/user-guide/training-strategy.doctree b/.doctrees/documentation/cellfinder/user-guide/training-strategy.doctree
diff --git a/.doctrees/documentation/general/conda.doctree b/.doctrees/documentation/general/conda.doctree
diff --git a/.doctrees/documentation/general/gpu.doctree b/.doctrees/documentation/general/gpu.doctree
diff --git a/.doctrees/documentation/general/image-definition.doctree b/.doctrees/documentation/general/image-definition.doctree
diff --git a/.doctrees/documentation/general/index.doctree b/.doctrees/documentation/general/index.doctree
diff --git a/.doctrees/documentation/index.doctree b/.doctrees/documentation/index.doctree
diff --git a/.doctrees/documentation/morphapi/index.doctree b/.doctrees/documentation/morphapi/index.doctree
diff --git a/.doctrees/documentation/morphapi/usage/downloading-data.doctree b/.doctrees/documentation/morphapi/usage/downloading-data.doctree
diff --git a/.doctrees/documentation/morphapi/usage/rendering-data.doctree b/.doctrees/documentation/morphapi/usage/rendering-data.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/external-tools.doctree b/.doctrees/external-tools.doctree
diff --git a/.doctrees/funders.doctree b/.doctrees/funders.doctree
diff --git a/.doctrees/governance-model.doctree b/.doctrees/governance-model.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/media.doctree b/.doctrees/media.doctree
diff --git a/.doctrees/more.doctree b/.doctrees/more.doctree
diff --git a/.doctrees/publications.doctree b/.doctrees/publications.doctree
diff --git a/.doctrees/tutorials/brainreg.doctree b/.doctrees/tutorials/brainreg.doctree
diff --git a/.doctrees/tutorials/cellfinder-cli/exploring-the-numerical-results.doctree b/.doctrees/tutorials/cellfinder-cli/exploring-the-numerical-results.doctree
diff --git a/.doctrees/tutorials/cellfinder-cli/index.doctree b/.doctrees/tutorials/cellfinder-cli/index.doctree
diff --git a/.doctrees/tutorials/cellfinder-cli/running-cellfinder.doctree b/.doctrees/tutorials/cellfinder-cli/running-cellfinder.doctree
diff --git a/.doctrees/tutorials/cellfinder-cli/setting-up.doctree b/.doctrees/tutorials/cellfinder-cli/setting-up.doctree
diff --git a/.doctrees/tutorials/cellfinder-cli/visualising-the-results.doctree b/.doctrees/tutorials/cellfinder-cli/visualising-the-results.doctree
diff --git a/.doctrees/tutorials/cellfinder-cli/visualising-your-data-in-brainrender.doctree b/.doctrees/tutorials/cellfinder-cli/visualising-your-data-in-brainrender.doctree
diff --git a/.doctrees/tutorials/index.doctree b/.doctrees/tutorials/index.doctree
diff --git a/.doctrees/tutorials/silicon-probe-tracking.doctree b/.doctrees/tutorials/silicon-probe-tracking.doctree
diff --git a/.doctrees/tutorials/tracing-tracking.doctree b/.doctrees/tutorials/tracing-tracking.doctree
diff --git a/404.html b/404.html
@@ -1,5 +1,4 @@
 
-
 <!DOCTYPE html>
 
 
@@ -28,23 +27,23 @@
 <link rel="preload" as="font" type="font/woff2" crossorigin href="/_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="/_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
 
-    <link rel="stylesheet" type="text/css" href="/_static/css/custom.css" />
-    <link rel="stylesheet" type="text/css" href="/_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="/_static/togglebutton.css" />
-    <link rel="stylesheet" type="text/css" href="/_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
+    <link rel="stylesheet" type="text/css" href="/_static/css/custom.css?v=1227d6e8" />
+    <link rel="stylesheet" type="text/css" href="/_static/pygments.css?v=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="/_static/togglebutton.css?v=13237357" />
+    <link rel="stylesheet" type="text/css" href="/_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="/_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
 <link rel="preload" as="script" href="/_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
 
-    <script data-url_root="#" id="documentation_options" src="/_static/documentation_options.js"></script>
-    <script src="/_static/doctools.js"></script>
-    <script src="/_static/sphinx_highlight.js"></script>
+    <script data-url_root="#" id="documentation_options" src="/_static/documentation_options.js?v=8df938ec"></script>
+    <script src="/_static/doctools.js?v=888ff710"></script>
+    <script src="/_static/sphinx_highlight.js?v=4825356b"></script>
     <script>let toggleHintShow = 'Click to show';</script>
     <script>let toggleHintHide = 'Click to hide';</script>
     <script>let toggleOpenOnPrint = 'true';</script>
-    <script src="/_static/togglebutton.js"></script>
-    <script src="/_static/design-tabs.js"></script>
+    <script src="/_static/togglebutton.js?v=4a39c7ea"></script>
+    <script src="/_static/design-tabs.js?v=36754332"></script>
     <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = '404';</script>
@@ -448,7 +447,7 @@ <h1>Page Not Found</h1>
     <div class="footer-items__start">
 
         <div class="footer-item"><p class="sphinx-version">
-Created using <a href="https://sphinx-doc.org/">Sphinx</a> 6.2.1.
+Created using <a href="https://sphinx-doc.org/">Sphinx</a> 7.1.0.
 <br/>
 </p>
 <p class="theme-version">

diff --git a/_sources/developers/index.md.txt b/_sources/developers/index.md.txt
@@ -17,7 +17,7 @@ of the core developers.
 
 ## To contribute a new atlas
 
-To add a new BrainGlobe atlas, please see the guide [here](/documentation/bg-atlasapi/adding-a-new-atlas)
+To add a new BrainGlobe atlas, please see the guide [here](/documentation/bg-atlasapi/adding-a-new-atlas).
 
 ## To improve the documentation
 
@@ -83,12 +83,14 @@ to the following conventions:
 - Ask for a review from someone specific if you think they would be a particularly suited reviewer (possibly noting
   why they are suited on the PR description)
 
+
 ## Further information
 :::{toctree}
 :maxdepth: 1
 tooling
 conventions
 testing
+new_releases
 Code of conduct <https://github.com/brainglobe/.github/blob/main/CODE_OF_CONDUCT.md>
 :::
 

diff --git a/_sources/developers/new_releases.md.txt b/_sources/developers/new_releases.md.txt
@@ -0,0 +1,85 @@
+# Publishing new releases
+
+BrianGlobe packages hosted on GitHub have CI workflows setup that are used to automatically upload and publish new version releases when they are made available.
+This is the preferred method for publishing new versions to `PyPI` (and where appropriate, the linked `conda` feedstocks) - avoid manual uploads where possible.
+
+Maintainers can trigger a new release by pushing a new tag, in the format `vX.Y.Z`, to the main branch of a package repository.
+The `v` prefix **is necessary** as the workflow will only attempt to upload to `PyPI` if the tag matches the format previously provided.
+The `X`, `Y`, and `Z` values should be integers corresponding to the new version number.
+
+## Triggering a new release
+
+The steps for triggering a new release are:
+
+1. Head to the "releases" UI on GitHub for the package you want to release a new version for, and select "draft a new release".
+2. In the "choose a tag" box, opt to create a new tag in the format described above. Ensure that the target is `main` (or the desired commit on `main` if the current `HEAD` is not the desired release state).
+3. Choose the release title. Typically, this is the same as the tag that will be created.
+4. In the "write" box, you should have the option to select the "previous tag". Choose the tag of the previous release, then select "generate release notes".
+5. Check the "set as latest release" box.
+6. Then hit "publish release".
+
+This will trigger a tag-push event to the `main` branch, which will set the [deployment workflow](#workflow-for-publishing-new-releases) in motion.
+You can now relax whilst the workflow uploads the new package version to `PyPI`; however you will need to look out for [`conda-forge` feedstock updates](#conda-forge-feedstocks) in the next couple of days, or pre-empt this by making your own.
+See the section on feedstocks for more information.
+
+### On the command line
+
+If you have an up-to-date clone of the package repository, you can create a release tag on the command line with
+
+```sh
+git tag vX.Y.Z 
+```
+
+or one of
+
+```sh
+git tag -a vX.Y.Z
+git tag -a vX.Y.Z -m "Tag annotation message"
+```
+
+if you want to annotate the tag; which is useful for tagging single-commit hotfixes or patches that might come after a release.
+
+Once you have created the tag, you can `git push --tags` back to the main repository to trigger the release workflow.
+**However** you still need to create release notes using the GitHub UI as described in [the section above](#triggering-a-new-release).
+You will need to select the tag you just pushed, rather than creating a new tag, when you start drafting the release notes. 
+
+### Failed workflows
+
+In the event that the release workflows fails after publishing a release, you will need to:
+
+- Delete the tag from the repository from the GitHub tags UI
+- Delete the release notes and release from the GitHub releases UI
+- Debug the build failure and the commits with the fix are merged into `main`
+- Begin the process over again.
+
+### `conda-forge` feedstocks
+
+A number of BrainGlobe packages are also available through `conda-forge`, providing an alternative installation method to `pip`.
+Each package available in this way has a feedstock repository, usually at the GitHub repository:
+
+```
+conda-forge/<package-name>-feedstock
+```
+
+
+These feedstocks are linked to their `PyPI` counterparts - when a new version comes available on `PyPI`, the `conda-forge` admin bot should open a PR in the feedstock repository which will update the version of the package available through `conda`.
+These PRs must be approved by one of the feedstock maintainers before they are merged in.
+
+- Feedstock maintainers and package maintainers may be different
+- New versions of packages will **NOT** be available through `conda` until these PRs are merged in.
+
+If the new version changes are extensive or non-trivial; a manual update to the `meta.yaml` "recipe" file might be needed, as the admin bot is unable to resolve complex edits.
+Examples of such changes are; changing package dependencies, introducing new submodules, and/or editing command-line entry-points.
+You will need to use the `conda-forge` CI to debug the builds when manually updating in this way.
+
+## Workflow for publishing new releases
+
+BrainGlobe repositories hosted on GitHub each possess a `test_and_deploy.yaml` workflow.
+The basic functionality of these workflows use the [neuroinformatics-unit](https://github.com/neuroinformatics-unit/actions) actions to:
+
+1. Lint the source code
+1. Check the package manifest
+1. Run the package tests
+
+These checks are run against _all_ PRs opened against the repository, and on the `main` branch when they are merged in.
+When a tag in the `vX.Y.Z` format is pushed to `main`, these checks are run again and _if they are successful_ the workflow will build the source distribution and upload this to `PyPI`.
diff --git a/_static/basic.css b/_static/basic.css
@@ -670,6 +670,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -738,6 +748,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

diff --git a/about.html b/about.html
@@ -1,13 +1,12 @@
 
-
 <!DOCTYPE html>
 
 
 <html lang="en" >
 
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>About &#8212; BrainGlobe</title>
 
@@ -29,23 +28,23 @@
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
 
-    <link rel="stylesheet" type="text/css" href="_static/css/custom.css" />
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="_static/togglebutton.css" />
-    <link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
+    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=1227d6e8" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
+    <link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-    <script src="_static/doctools.js"></script>
-    <script src="_static/sphinx_highlight.js"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8df938ec"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script>let toggleHintShow = 'Click to show';</script>
     <script>let toggleHintHide = 'Click to hide';</script>
     <script>let toggleOpenOnPrint = 'true';</script>
-    <script src="_static/togglebutton.js"></script>
-    <script src="_static/design-tabs.js"></script>
+    <script src="_static/togglebutton.js?v=4a39c7ea"></script>
+    <script src="_static/design-tabs.js?v=36754332"></script>
     <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'about';</script>
@@ -588,7 +587,7 @@ <h1>More details<a class="headerlink" href="#more-details" title="Permalink to t
     <div class="footer-items__start">
 
         <div class="footer-item"><p class="sphinx-version">
-Created using <a href="https://sphinx-doc.org/">Sphinx</a> 6.2.1.
+Created using <a href="https://sphinx-doc.org/">Sphinx</a> 7.1.0.
 <br/>
 </p>
 <p class="theme-version">

diff --git a/contact.html b/contact.html
@@ -1,13 +1,12 @@
 
-
 <!DOCTYPE html>
 
 
 <html lang="en" >
 
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>Contact &#8212; BrainGlobe</title>
 
@@ -29,23 +28,23 @@
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
 
-    <link rel="stylesheet" type="text/css" href="_static/css/custom.css" />
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="_static/togglebutton.css" />
-    <link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
+    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=1227d6e8" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
+    <link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-    <script src="_static/doctools.js"></script>
-    <script src="_static/sphinx_highlight.js"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8df938ec"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script>let toggleHintShow = 'Click to show';</script>
     <script>let toggleHintHide = 'Click to hide';</script>
     <script>let toggleOpenOnPrint = 'true';</script>
-    <script src="_static/togglebutton.js"></script>
-    <script src="_static/design-tabs.js"></script>
+    <script src="_static/togglebutton.js?v=4a39c7ea"></script>
+    <script src="_static/design-tabs.js?v=36754332"></script>
     <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'contact';</script>
@@ -536,7 +535,7 @@ <h2>Other ways to get in touch<a class="headerlink" href="#other-ways-to-get-in-
     <div class="footer-items__start">
 
         <div class="footer-item"><p class="sphinx-version">
-Created using <a href="https://sphinx-doc.org/">Sphinx</a> 6.2.1.
+Created using <a href="https://sphinx-doc.org/">Sphinx</a> 7.1.0.
 <br/>
 </p>
 <p class="theme-version">

diff --git a/contributors.html b/contributors.html
@@ -1,13 +1,12 @@
 
-
 <!DOCTYPE html>
 
 
 <html lang="en" >
 
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>Contributors &#8212; BrainGlobe</title>
 
@@ -29,23 +28,23 @@
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
 
-    <link rel="stylesheet" type="text/css" href="_static/css/custom.css" />
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="_static/togglebutton.css" />
-    <link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" />
+    <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=1227d6e8" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
+    <link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-    <script src="_static/doctools.js"></script>
-    <script src="_static/sphinx_highlight.js"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8df938ec"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script>let toggleHintShow = 'Click to show';</script>
     <script>let toggleHintHide = 'Click to hide';</script>
     <script>let toggleOpenOnPrint = 'true';</script>
-    <script src="_static/togglebutton.js"></script>
-    <script src="_static/design-tabs.js"></script>
+    <script src="_static/togglebutton.js?v=4a39c7ea"></script>
+    <script src="_static/design-tabs.js?v=36754332"></script>
     <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'contributors';</script>
@@ -1183,7 +1182,7 @@ <h1>Contributors<a class="headerlink" href="#contributors" title="Permalink to t
     <div class="footer-items__start">
 
         <div class="footer-item"><p class="sphinx-version">
-Created using <a href="https://sphinx-doc.org/">Sphinx</a> 6.2.1.
+Created using <a href="https://sphinx-doc.org/">Sphinx</a> 7.1.0.
 <br/>
 </p>
 <p class="theme-version">