moving build/html files.

ins-amu · Dec 5, 2023 · 4723a10 · 4723a10
1 parent 1f68bde
commit 4723a10
Show file tree

Hide file tree

Showing 13 changed files with 328 additions and 21 deletions.
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -9,12 +9,78 @@ Welcome to vbjax's documentation!
 
 Introduction
 ############
+`vbjax` is a Jax-based package for working with virtual brain style models.
+
+Installation
+############
+
+Installs with `pip install "vbjax"`, but you can use the source,
+
+.. code-block:: bash
+
+   git clone https://github.com/ins-amu/vbjax
+   cd vbjax
+   pip install .[dev]
+
+
+The primary additional dependency of vbjax is
+[JAX](github.com/google/jax), which itself depends only on
+NumPy, SciPy & opt-einsum, so it should be safe to add to your
+existing projects.
+
+gee pee you
+------------
+
+**CUDA**
+
+If you have a CUDA-enabled GPU, you install the requisite dependencies like so
+
+.. code-block:: bash
+
+   pip install --upgrade "jax[cuda11_pip]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
+
+
+**M1/M2** 🍎
+
+On newer Apple machines w/ M1 or M2 GPUs, JAX supports using the GPU experimentally
+by installing just two extra packages:
+
+.. code-block:: bash
+
+   pip install ml-dtypes==0.2.0 jax-metal
+
+
+About a third of vbjax tests fail due to absence of certain operations like n-dim
+scatter/gather & FFTs, and it may not be faster because these CPUs already have
+excellent memory bandwidth & latency hiding.
+
+**CUDA** 🐳 
+
+*BUT* because GPU software stack versions make aligning stars look like child's play,
+container images are available and auto-built w/
+[GitHub Actions](.github/workflows/docker-image.yml), so you can use w/ Docker
+
+.. code-block:: bash
+
+   docker run --rm -it ghcr.io/ins-amu/vbjax:main python3 -c 'import vbjax; print(vbjax.__version__)'
+
+
+The images are built on Nvidia runtime images, so `--gpus all` is enough
+for Jax to discover the GPU(s).
+
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
 
+Tutorial
+########
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   tutorial
 
 Indices and tables
 ==================

diff --git a/docs/_sources/tutorial.rst.txt b/docs/_sources/tutorial.rst.txt
@@ -0,0 +1,6 @@
+
+Tutorial
+***************
+
+This is some test text.
+
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
diff --git a/docs/build/html/.nojekyll b/docs/build/html/.nojekyll
diff --git a/docs/copy_html.sh b/docs/copy_html.sh
@@ -0,0 +1,7 @@
+
+rm -rf _modules
+rm -rf _sources
+rm -rf _static
+make html 
+cp -r build/html/* .
+rm -rf build
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,12 +9,78 @@ Welcome to vbjax's documentation!
 
 Introduction
 ############
+`vbjax` is a Jax-based package for working with virtual brain style models.
+
+Installation
+############
+
+Installs with `pip install "vbjax"`, but you can use the source,
+
+.. code-block:: bash
+
+   git clone https://github.com/ins-amu/vbjax
+   cd vbjax
+   pip install .[dev]
+
+
+The primary additional dependency of vbjax is
+[JAX](github.com/google/jax), which itself depends only on
+NumPy, SciPy & opt-einsum, so it should be safe to add to your
+existing projects.
+
+gee pee you
+------------
+
+**CUDA**
+
+If you have a CUDA-enabled GPU, you install the requisite dependencies like so
+
+.. code-block:: bash
+
+   pip install --upgrade "jax[cuda11_pip]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
+
+
+**M1/M2** 🍎
+
+On newer Apple machines w/ M1 or M2 GPUs, JAX supports using the GPU experimentally
+by installing just two extra packages:
+
+.. code-block:: bash
+
+   pip install ml-dtypes==0.2.0 jax-metal
+
+
+About a third of vbjax tests fail due to absence of certain operations like n-dim
+scatter/gather & FFTs, and it may not be faster because these CPUs already have
+excellent memory bandwidth & latency hiding.
+
+**CUDA** 🐳 
+
+*BUT* because GPU software stack versions make aligning stars look like child's play,
+container images are available and auto-built w/
+[GitHub Actions](.github/workflows/docker-image.yml), so you can use w/ Docker
+
+.. code-block:: bash
+
+   docker run --rm -it ghcr.io/ins-amu/vbjax:main python3 -c 'import vbjax; print(vbjax.__version__)'
+
+
+The images are built on Nvidia runtime images, so `--gpus all` is enough
+for Jax to discover the GPU(s).
+
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
 
+Tutorial
+########
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   tutorial
 
 Indices and tables
 ==================

diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
@@ -0,0 +1,6 @@
+
+Tutorial
+***************
+
+This is some test text.
+
diff --git a/docs/tutorial.html b/docs/tutorial.html
@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="./">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>Tutorial &#8212; vbjax v0.0.10 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
+    <link rel="stylesheet" type="text/css" href="_static/nature.css?v=601dbdee" />
+    <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
+    <script src="_static/documentation_options.js?v=03166b9c"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="Welcome to vbjax’s documentation!" href="index.html" /> 
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="index.html" title="Welcome to vbjax’s documentation!"
+             accesskey="P">previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">vbjax v0.0.10 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Tutorial</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+
+  <section id="tutorial">
+<h1>Tutorial<a class="headerlink" href="#tutorial" title="Link to this heading">¶</a></h1>
+<p>This is some test text.</p>
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="index.html"
+                          title="previous chapter">Welcome to vbjax’s documentation!</a></p>
+  </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="_sources/tutorial.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="right" >
+          <a href="index.html" title="Welcome to vbjax’s documentation!"
+             >previous</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">vbjax v0.0.10 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Tutorial</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2023, Marmaduke Woodman.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>