Deployed c199590 with MkDocs version: 1.5.3

jaxleyverse · Aug 20, 2024 · 9311489 · 9311489
1 parent e4f9b95
commit 9311489
Show file tree

Hide file tree

Showing 25 changed files with 344 additions and 257 deletions.
diff --git a/404.html b/404.html
@@ -16,7 +16,7 @@
 
 
 
-        <title>jaxley</title>
+        <title>Jaxley</title>
 
 
 
@@ -79,7 +79,7 @@
 
 <header class="md-header md-header--shadow" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="/jaxley/." title="jaxley" class="md-header__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href="/jaxley/." title="Jaxley" class="md-header__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="/jaxley/logo_white.png" alt="logo">
 
@@ -92,7 +92,7 @@
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
-            jaxley
+            Jaxley
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
@@ -185,12 +185,12 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="/jaxley/." title="jaxley" class="md-nav__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href="/jaxley/." title="Jaxley" class="md-nav__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="/jaxley/logo_white.png" alt="logo">
 
     </a>
-    jaxley
+    Jaxley
   </label>
 
     <div class="md-nav__source">
@@ -399,7 +399,7 @@
 
 
   <span class="md-ellipsis">
-    Optimization
+    Training models
   </span>
 
 

diff --git a/code_of_conduct/index.html b/code_of_conduct/index.html
@@ -22,7 +22,7 @@
 
 
 
-        <title>Code of Conduct - jaxley</title>
+        <title>Code of Conduct - Jaxley</title>
 
 
 
@@ -90,7 +90,7 @@
 
 <header class="md-header md-header--shadow" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href=".." title="jaxley" class="md-header__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href=".." title="Jaxley" class="md-header__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="../logo_white.png" alt="logo">
 
@@ -103,7 +103,7 @@
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
-            jaxley
+            Jaxley
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
@@ -196,12 +196,12 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href=".." title="jaxley" class="md-nav__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href=".." title="Jaxley" class="md-nav__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="../logo_white.png" alt="logo">
 
     </a>
-    jaxley
+    Jaxley
   </label>
 
     <div class="md-nav__source">
@@ -410,7 +410,7 @@
 
 
   <span class="md-ellipsis">
-    Optimization
+    Training models
   </span>
 
 

diff --git a/contribute/index.html b/contribute/index.html
@@ -22,7 +22,7 @@
 
 
 
-        <title>Guide - jaxley</title>
+        <title>Guide - Jaxley</title>
 
 
 
@@ -90,7 +90,7 @@
 
 <header class="md-header md-header--shadow" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href=".." title="jaxley" class="md-header__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href=".." title="Jaxley" class="md-header__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="../logo_white.png" alt="logo">
 
@@ -103,7 +103,7 @@
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
-            jaxley
+            Jaxley
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
@@ -196,12 +196,12 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href=".." title="jaxley" class="md-nav__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href=".." title="Jaxley" class="md-nav__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="../logo_white.png" alt="logo">
 
     </a>
-    jaxley
+    Jaxley
   </label>
 
     <div class="md-nav__source">
@@ -410,7 +410,7 @@
 
 
   <span class="md-ellipsis">
-    Optimization
+    Training models
   </span>
 
 
@@ -924,19 +924,19 @@
   <h1>Guide</h1>
 
 <h2 id="user-experiences-bugs-and-feature-requests">User experiences, bugs, and feature requests<a class="headerlink" href="#user-experiences-bugs-and-feature-requests" title="Permanent link">&para;</a></h2>
-<p>To report bugs and suggest features (including better documentation), please equally
+<p>To report bugs and suggest features (including better documentation), please
 head over to <a href="https://github.com/jaxleyverse/jaxley/issues">issues on GitHub</a>.</p>
 <h2 id="code-contributions">Code contributions<a class="headerlink" href="#code-contributions" title="Permanent link">&para;</a></h2>
-<p>In general, we use pull requests to make changes to <code>jaxley</code>. So, if you are planning to
+<p>In general, we use pull requests to make changes to <code>Jaxley</code>. So, if you are planning to
 make a contribution, please fork, create a feature branch and then make a PR from
-your feature branch to the upstream <code>jaxley</code> (<a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork">details</a>).</p>
+your feature branch to the upstream <code>Jaxley</code> (<a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork">details</a>).</p>
 <h3 id="development-environment">Development environment<a class="headerlink" href="#development-environment" title="Permanent link">&para;</a></h3>
 <p>Clone <a href="https://github.com/jaxleyverse/jaxley">the repo</a> and install via <code>setup.py</code> using <code>pip install -e ".[dev]"</code> (the dev
 flag installs development and testing dependencies).</p>
 <h3 id="style-conventions">Style conventions<a class="headerlink" href="#style-conventions" title="Permanent link">&para;</a></h3>
 <p>For docstrings and comments, we use <a href="http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings">Google
 Style</a>.</p>
-<p>Code needs to pass through the following tools, which are installed alongside <code>jaxley</code>:</p>
+<p>Code needs to pass through the following tools, which are installed alongside <code>Jaxley</code>:</p>
 <p><strong><a href="https://github.com/psf/black">black</a></strong>: Automatic code formatting for Python. You can
 run black manually from the console using <code>black .</code> in the top directory of the
 repository, which will format all files.</p>

diff --git a/credits/index.html b/credits/index.html
@@ -20,7 +20,7 @@
 
 
 
-        <title>Credits - jaxley</title>
+        <title>Credits - Jaxley</title>
 
 
 
@@ -88,7 +88,7 @@
 
 <header class="md-header md-header--shadow" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href=".." title="jaxley" class="md-header__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href=".." title="Jaxley" class="md-header__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="../logo_white.png" alt="logo">
 
@@ -101,7 +101,7 @@
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
-            jaxley
+            Jaxley
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
@@ -194,12 +194,12 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href=".." title="jaxley" class="md-nav__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href=".." title="Jaxley" class="md-nav__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="../logo_white.png" alt="logo">
 
     </a>
-    jaxley
+    Jaxley
   </label>
 
     <div class="md-nav__source">
@@ -408,7 +408,7 @@
 
 
   <span class="md-ellipsis">
-    Optimization
+    Training models
   </span>
 
 
@@ -876,20 +876,19 @@
 
 
 <h1 id="credits">Credits<a class="headerlink" href="#credits" title="Permanent link">&para;</a></h1>
-<p><code>jaxley</code> is a collaborative project between the groups of Jakob Macke (Uni Tübingen), Pedro Gonçalves (KU Leuven / NERF), and Philipp Berens (Uni Tübingen).</p>
+<p><code>Jaxley</code> is a collaborative project between the groups of Jakob Macke (Uni Tübingen), Pedro Gonçalves (KU Leuven / NERF), and Philipp Berens (Uni Tübingen).</p>
 <h2 id="license">License<a class="headerlink" href="#license" title="Permanent link">&para;</a></h2>
-<p><code>jaxley</code> is licensed under the <a href="https://www.gnu.org/licenses/agpl-3.0.html">Affero General Public License version 3 (AGPLv3)</a> and</p>
+<p><code>Jaxley</code> is licensed under the <a href="https://github.com/jaxleyverse/jaxley/blob/main/LICENSE">Apache License</a> and</p>
 <blockquote>
-<p>Copyright (C) 2020 Michael Deistler.</p>
+<p>Copyright (C) 2024 Michael Deistler, Jakob H. Macke, Pedro J. Goncalves, Philipp Berens.</p>
 </blockquote>
 <h2 id="important-dependencies-and-prior-art">Important dependencies and prior art<a class="headerlink" href="#important-dependencies-and-prior-art" title="Permanent link">&para;</a></h2>
 <ul>
 <li><code>NEURON</code></li>
 </ul>
 <h2 id="citation">Citation<a class="headerlink" href="#citation" title="Permanent link">&para;</a></h2>
 <p>If you use <code>jaxley</code> consider citing the corresponding paper:
-<div class="highlight"><pre><span></span><code>@article{deistler,
-}
+<div class="highlight"><pre><span></span><code>@article{}
 </code></pre></div></p>
 
 

diff --git a/faq/index.html b/faq/index.html
@@ -22,7 +22,7 @@
 
 
 
-        <title>FAQ - jaxley</title>
+        <title>FAQ - Jaxley</title>
 
 
 
@@ -90,7 +90,7 @@
 
 <header class="md-header md-header--shadow" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href=".." title="jaxley" class="md-header__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href=".." title="Jaxley" class="md-header__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="../logo_white.png" alt="logo">
 
@@ -103,7 +103,7 @@
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
-            jaxley
+            Jaxley
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
@@ -196,12 +196,12 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href=".." title="jaxley" class="md-nav__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href=".." title="Jaxley" class="md-nav__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="../logo_white.png" alt="logo">
 
     </a>
-    jaxley
+    Jaxley
   </label>
 
     <div class="md-nav__source">
@@ -410,7 +410,7 @@
 
 
   <span class="md-ellipsis">
-    Optimization
+    Training models
   </span>
 
 
@@ -786,7 +786,7 @@
 
 
 <h1 id="frequently-asked-questions">Frequently asked questions<a class="headerlink" href="#frequently-asked-questions" title="Permanent link">&para;</a></h1>
-<p><a href="question_01/">What makes <code>jaxley</code> different from other libraries?</a></p>
+<p><a href="question_01/">What makes <code>Jaxley</code> different from other libraries?</a></p>
 
 
 

diff --git a/faq/question_01/index.html b/faq/question_01/index.html
@@ -18,7 +18,7 @@
 
 
 
-        <title>What makes jaxley different from other libraries? - jaxley</title>
+        <title>What makes jaxley different from other libraries? - Jaxley</title>
 
 
 
@@ -86,7 +86,7 @@
 
 <header class="md-header md-header--shadow" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="jaxley" class="md-header__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href="../.." title="Jaxley" class="md-header__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="../../logo_white.png" alt="logo">
 
@@ -99,7 +99,7 @@
       <div class="md-header__ellipsis">
         <div class="md-header__topic">
           <span class="md-ellipsis">
-            jaxley
+            Jaxley
           </span>
         </div>
         <div class="md-header__topic" data-md-component="header-topic">
@@ -192,12 +192,12 @@
 
 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="jaxley" class="md-nav__button md-logo" aria-label="jaxley" data-md-component="logo">
+    <a href="../.." title="Jaxley" class="md-nav__button md-logo" aria-label="Jaxley" data-md-component="logo">
 
   <img src="../../logo_white.png" alt="logo">
 
     </a>
-    jaxley
+    Jaxley
   </label>
 
     <div class="md-nav__source">
@@ -406,7 +406,7 @@
 
 
   <span class="md-ellipsis">
-    Optimization
+    Training models
   </span>