Merge pull request #35 from MunchLab/23-make-a-logo

23 make a logo
MunchLab · Jan 9, 2025 · e0dd6be · e0dd6be
2 parents 66e3098 + 5d27b19
commit e0dd6be
Show file tree

Hide file tree

Showing 88 changed files with 4,177 additions and 1,357 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ Right now, the content includes stuff for doing ECT on graphs embedded in 2D. Ev
 
 For more information on the ECT, see:
 
-> Elizabeth Munch. An Invitation to the Euler Characteristic Transform. [arXiv:2310.10395](https://arxiv.org/abs/2310.10395). 2023.
+>  Munch, Elizabeth. An Invitation to the Euler Characteristic Transform. The American Mathematical Monthly, 132(1), 15-25. [doi:10.1080/00029890.2024.2409616](https://doi.org/10.1080/00029890.2024.2409616). 2024.
 
 ## Getting Started
 
@@ -45,6 +45,7 @@ pip install .
 This code was written by [Liz Munch](https://elizabethmunch.com/) along with her research group and collaborators. People who have contributed to `ect` include:
 
 - [Sarah McGuire](https://www.sarah-mcguire.com/)
+- [Yemeen Ayub](https://yemeen.com/)
 
 ## License
 

diff --git a/doc_source/citing.rst b/doc_source/citing.rst
@@ -3,5 +3,5 @@ Citing
 
 To cite `ect` please use the following publication:
 
-   Elizabeth Munch. An Invitation to the Euler Characteristic Transform. `arXiv:2310.10395 <https://arxiv.org/abs/2310.10395>`_. 2023.
+   Munch, Elizabeth. An Invitation to the Euler Characteristic Transform. The American Mathematical Monthly, 132(1), 15-25. `doi:10.1080/00029890.2024.2409616 <https://doi.org/10.1080/00029890.2024.2409616>`_. 2024.
 
diff --git a/doc_source/conf.py b/doc_source/conf.py
@@ -24,7 +24,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'ect'
-copyright = '2024, MunchLab'
+copyright = '2025, MunchLab'
 author = 'MunchLab'
 
 # The full version, including alpha/beta/rc tags
@@ -70,12 +70,29 @@
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
+html_logo = 'img/ECT_Logo.png'
+html_favicon = 'img/ECT_Logo_128x128.png'
+html_theme_options = {
+    'canonical_url': '',
+    'analytics_id': 'UA-XXXXXXX-1',  #  Provided by Google in your dashboard
+    'logo_only': False,
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    'style_external_links': True,
+    'style_nav_header_background': '#cececf',
+    # Toc options
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+    'navigation_depth': 3,
+    'includehidden': True,
+    'titles_only': False,
+}
 autodoc_default_options = {
     'members': True,
     'member-order': 'bysource',
     'special-members': '__init__',
     'undoc-members': True,
-    'exclude-members': '__weakref__'
+    'exclude-members': '__weakref__',
 }
 numpydoc_show_class_members = False
 autodoc_typehints = "none"

diff --git a/doc_source/img/ECT_Logo.png b/doc_source/img/ECT_Logo.png
diff --git a/doc_source/img/ECT_Logo_128x128.png b/doc_source/img/ECT_Logo_128x128.png
diff --git a/doc_source/img/ECT_Logo_150x111.png b/doc_source/img/ECT_Logo_150x111.png
diff --git a/doc_source/img/ECT_Logo_32x32.png b/doc_source/img/ECT_Logo_32x32.png
diff --git a/doc_source/img/ECT_Logo_64x64.png b/doc_source/img/ECT_Logo_64x64.png
diff --git a/doc_source/index.rst b/doc_source/index.rst
@@ -25,7 +25,7 @@ Right now, the content includes stuff for doing ECT on graphs embedded in 2D. Ev
 
 For more information on the ECT, see:
 
-   Elizabeth Munch. An Invitation to the Euler Characteristic Transform. `arXiv:2310.10395 <https://arxiv.org/abs/2310.10395>`_. 2023.
+   Munch, Elizabeth. An Invitation to the Euler Characteristic Transform. The American Mathematical Monthly, 132(1), 15-25. `doi:10.1080/00029890.2024.2409616 <https://doi.org/10.1080/00029890.2024.2409616>`_. 2024.
 
 Getting Started
 ---------------
@@ -69,6 +69,7 @@ Authors
 This code was written by `Liz Munch <https://elizabethmunch.com/>`_ along with her research group and collaborators. People who have contributed to `ect` include:
 
 - `Sarah McGuire <https://www.sarah-mcguire.com/>`_
+- `Yemeen Ayub <https://yemeen.com/>`_
 
 License
 -------

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 1dadfd971d70ecf359ab515ba8084b45
+config: 4fa06ba1eba33764a2433ecca7acac59
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_modules/ect/ect_graph.html b/docs/_modules/ect/ect_graph.html
diff --git a/docs/_modules/ect/embed_cw.html b/docs/_modules/ect/embed_cw.html
@@ -1,22 +1,25 @@
-
-
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" data-content_root="../../">
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>ect.embed_cw &mdash; ect 0.1.5 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
-      <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
+      <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
 
 
-      <script src="../../_static/jquery.js?v=5d32c60e"></script>
-      <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../_static/documentation_options.js?v=59fadc99"></script>
-      <script src="../../_static/doctools.js?v=9bcbadda"></script>
-      <script src="../../_static/sphinx_highlight.js?v=dc90522c"></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>
+    <link rel="shortcut icon" href="../../_static/ECT_Logo_128x128.png"/>
+  <!--[if lt IE 9]>
+    <script src="../../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../../_static/documentation_options.js?v=59fadc99"></script>
+        <script src="../../_static/doctools.js?v=9a2dae69"></script>
+        <script src="../../_static/sphinx_highlight.js?v=dc90522c"></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 src="../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" /> 
@@ -26,12 +29,13 @@
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
-        <div class="wy-side-nav-search" >
+        <div class="wy-side-nav-search"  style="background: #cececf" >
 
 
 
           <a href="../../index.html" class="icon icon-home">
             ect
+              <img src="../../_static/ECT_Logo.png" class="logo" alt="Logo"/>
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -43,10 +47,55 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../installation.html">1. Getting Started</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../modules.html">2. Modules</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../tutorials.html">3. Tutorials</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">4. Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../installation.html">1. Getting Started</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../installation.html#prerequisites">1.1. Prerequisites</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../installation.html#installing-ect">1.2. Installing <cite>ect</cite></a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../installation.html#uninstalling-ect">1.3. Uninstalling <cite>ect</cite></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../../modules.html">2. Modules</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../embed_graph.html">2.1. Embedded graphs</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../embed_graph.html#ect.embed_graph.EmbeddedGraph"><code class="docutils literal notranslate"><span class="pre">EmbeddedGraph</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../embed_graph.html#ect.embed_graph.create_example_graph"><code class="docutils literal notranslate"><span class="pre">create_example_graph()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../../embed_cw.html">2.2. Embedded CW complex</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../embed_cw.html#ect.embed_cw.EmbeddedCW"><code class="docutils literal notranslate"><span class="pre">EmbeddedCW</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../embed_cw.html#ect.embed_cw.create_example_cw"><code class="docutils literal notranslate"><span class="pre">create_example_cw()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../../ect_on_graphs.html">2.3. ECT on graphs</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../ect_on_graphs.html#ect.ect_graph.ECT"><code class="docutils literal notranslate"><span class="pre">ECT</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../../tutorials.html">3. Tutorials</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../notebooks/Tutorial-ECT_for_embedded_graphs.html">3.1. Tutorial : ECT for embedded graphs</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../notebooks/Tutorial-ECT_for_embedded_graphs.html#Constructing-the-embedded-graph">3.1.1. Constructing the embedded graph</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../notebooks/Tutorial-ECT_for_embedded_graphs.html#Computing-the-ECT-of-G">3.1.2. Computing the ECT of <span class="math notranslate nohighlight">\(G\)</span></a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../notebooks/Tutorial-ECT_for_embedded_graphs.html#SECT">3.1.3. SECT</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../../notebooks/Tutorial-ECT_for_CW_Complexes.html">3.2. Tutorial: ECT for CW complexes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../notebooks/Matisse/Matisse_ECT.html">3.3. ECT on Matisse’s “The Parakeet and the Mermaid”</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../notebooks/Matisse/Matisse_ECT.html#Acknowledgements">3.3.1. Acknowledgements</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">4. Contributing</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../contributing.html#getting-started">4.1. Getting Started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../contributing.html#contributing-guidelines">4.2. Contributing Guidelines</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../contributing.html#code-style-and-formatting">4.2.1. Code style and formatting</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../contributing.html#documentation-guidelines">4.2.2. Documentation guidelines</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../contributing.html#testing-guidelines">4.2.3. Testing guidelines</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../contributing.html#issue-tracking-and-pull-requests">4.2.4. Issue tracking and pull requests</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../../contributing.html#conclusion">4.3. Conclusion</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="../../license.html">5. License</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../citing.html">6. Citing</a></li>
 </ul>
@@ -55,13 +104,13 @@
       </div>
     </nav>
 
-    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu"  style="background: #cececf" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="../../index.html">ect</a>
       </nav>
 
       <div class="wy-nav-content">
-        <div class="rst-content">
+        <div class="rst-content style-external-links">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
@@ -315,7 +364,7 @@ <h1>Source code for ect.embed_cw</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, MunchLab.</p>
+    <p>&#169; Copyright 2025, MunchLab.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
@@ -332,7 +381,18 @@ <h1>Source code for ect.embed_cw</h1><div class="highlight"><pre>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
+    <!-- Theme Analytics -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-XXXXXXX-1"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+
+      gtag('config', 'UA-XXXXXXX-1', {
+          'anonymize_ip': false,
+      });
+    </script> 
 
 </body>
 </html>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,5 +3,5 @@ Citing

		To cite `ect` please use the following publication:

		Elizabeth Munch. An Invitation to the Euler Characteristic Transform. `arXiv:2310.10395 <https://arxiv.org/abs/2310.10395>`_. 2023.
		Munch, Elizabeth. An Invitation to the Euler Characteristic Transform. The American Mathematical Monthly, 132(1), 15-25. `doi:10.1080/00029890.2024.2409616 <https://doi.org/10.1080/00029890.2024.2409616>`_. 2024.