update toltec theme

Author: Jerry-Ma

CONTRIBUTING.rst

@@ -1,6 +1,12 @@
 Contributing
 ============
 
+The TolTECA tutorials repository is modeled after the
+`Astropy Tutorials <https://github.com/astropy/astropy-tutorials>`_.
+
+Included below is the `CONTRIBUTING.rst <https://github.com/astropy/astropy-tutorials/blob/master/CONTRIBUTING.rst>`_ in the astropy tutorials repository
+which also serves as the guideline of contributing to this TolTECA tutorials.
+
 Overview
 --------
 
@@ -250,8 +256,8 @@ To use this approach, follow these steps:
 * You will need to sign up for an account with Zenodo before you can upload a file there.
 
 * After a Zenodo account has been properly set up, be sure to log in and do a new upload. Follow
-the Zenodo instructions and complete all the required fields as the bare minimum in order to have
-the data file(s) uploaded to their records. Once this is done you will have a link to share the data.
+  the Zenodo instructions and complete all the required fields as the bare minimum in order to have
+  the data file(s) uploaded to their records. Once this is done you will have a link to share the data.
 
 * With the link to the data file record, which has the format ``https://zenodo.org/api/records/:id``, an example HTTP GET request needed to retrieve the data using the Python package ``requests`` is shown below::
 

mkdocs.yml

@@ -0,0 +1,2 @@
+site_name: TolTECA Tutorials
+docs_dir: build/html

pip-requirements-dev.txt

@@ -0,0 +1,8 @@
+git+https://github.com/toltec-astro/tollan.git
+git+https://github.com/toltec-astro/kidsproc.git
+git+https://github.com/toltec-astro/tolteca.git
+matplotlib==3.0.2
+jupyter>=1.0
+notebook>=5.7.2
+nbconvert
+pandoc

tutorials/_static/astropy.css

@@ -82,9 +82,10 @@ a:hover{
   color: #ffffff !important;
 }
 
-#astropy-logo {
+#toltec-logo {
   width: 35vw;
-  padding-top: 100px;
+  padding-top: 22px;
+  margin-bottom: -12px;
 }
 
 .landing {
@@ -320,4 +321,4 @@ a.reference.internal.nav-header {
     margin-left: 20px !important;
     margin-right: 20px !important;
   }
-}
+}

tutorials/_static/toltec_favicon.ico

@@ -1,7 +1,6 @@
 Documentation
 =============
 
-Documentation has the complete description of an Astropy package with all requisite details including usage, dependencies, and examples.
-Documentation is comprehensive reference material—it's possibly a little dry, but is both basic and high level.
-
-See the `Astropy documentation <http://docs.astropy.org/en/stable/>`_ for a structured view of the functionality within the Astropy project.
+Documentation has the complete description of the components of TolTECA.
+Check the `toltec-astro Github repositories <https://github.com/toltec-astro/>`_
+(``toltec-astro`` member loggin required) for the documentation of each package.

tutorials/_static/toltec_logo.png

@@ -1,43 +1,74 @@
-Learn Astropy
-=============
-Astropy is a Python library for use in astronomy.
-Learn Astropy provides a portal to all of the Astropy educational material through a single dynamically searchable web page.
-It allows you to filter tutorials by keywords, search for filters, and make search queries in tutorials and documentation simultaneously.
+TolTECA
+=======
 
-Installing Astropy
+`TolTECA <https://github.com/toltec-astro>`_ is the software stack developed to
+facilitate the data analysis tasks of the
+`TolTEC camera <http://toltec.astro.umass.edu>`_, which is to be mounted on the
+`Large Millimeter Telescope (LMT) <http://www.lmtgtm.org>`_ and provides simultaneous,
+polarization-sensitive imaging at wavelengths of 1.1, 1.4 and 2.0mm through its
+7718 Lumped element Kinetic Inductance Detectors (KIDs). For more detailed
+description, please check out our recent SPIE papers
+`TolTEC <https://ui.adsabs.harvard.edu/abs/2020SPIE11453E..02W/abstract>`_
+and `TolTECA <https://ui.adsabs.harvard.edu/abs/2020SPIE11452E..2OM/abstract>`_.
+
+This site hosts a wide range of learning materials and documentations for those
+who would like to working with TolTEC data. The site is equipped with a search
+box that allows you to filter tutorials by keywords, search for filters, and
+make search queries in tutorials and documentation simultaneously.
+
+
+Installing TolTECA
 ------------------
 
-The `Anaconda Python Distribution <https://www.anaconda.com/download/>`_ includes Astropy and is the recommended way to install both Python and the Astropy package. Once you have Anaconda installed, use the following to update to the latest version of Astropy:
+The two key components of TolTECA are the Python package ``tolteca``, and the
+fast data reduction engine ``citlali`` written in C++. Tolteca implements the
+general data and pipeline management framework that serves at the highest
+levels, while ``citlali`` works at the low-level to carry out the actual KIDs
+readout signal interpretation, time-ordered data (TOD) processing, and
+map-making. All the software source codes can be found in the
+`toltec-astro <https://github.com/toltec-astro>`_ Github page.
+
+.. tip::
+
+    As of March 2021, the repositories are only available to `toltec-astro`
+    organization members. please send email to zhiyuanma (at) umass (dot) edu
+    if you would like to have access.
+
 
-.. code:: python
+To download and run the Jupyter notebook tutorials, one need to install the
+Python package ``tolteca`` and its dependencies, which can be done as follows:
 
-    conda update astropy
+.. code::
 
-To install Astropy from the source into an existing Python installation, see the more detailed `installation instructions <http://astropy.readthedocs.io/en/stable/install.html>`_ in the main Astropy documentation.
+    $ git clone https://github.com/toltec-astro/tolteca_tutorials.git
+    $ cd tolteca_tutorials
+    $ pip install -r pip-requirements.txt
 
-Get help
---------
 
-If you have any questions regarding using Astropy there are numerous channels for communication.
-Post to any one of `several forums <https://www.astropy.org/help.html>`_ to get help from our active, helpful, and friendly community of users and developers.
+For more detailed instructions of installing ``tolteca`` and to learn about the
+C++ data reduction engine ``citlali``, see their documentations
+`tolteca <https://github.com/toltec-astro/tolteca>`_ and
+`citlali <https://toltec-astro.github.io/citlali/>`_.
+
 
 For contributors
 ----------------
 
-We welcome feedback, improvements, and new tutorial content via the `Astropy
-Tutorials Repository <https://github.com/astropy/astropy-tutorials>`_  on
-GitHub. If you find a typo or would like to clarify some text, please either
-`create an issue <https://github.com/astropy/astropy-tutorials/issues/new>`_ or
-make the change yourself and then submit a pull request directly to the
-repository. Questions and/or comments about the tutorials are welcome on the
-`astropy-dev <https://groups.google.com/forum/#!forum/astropy-dev>`_ mailing
-list. For more information, please see the contributing documentation:
+Feedback, improvements, and new tutorial content are highly appreciated
+via the `TolTECA tutorials repository <https://github.com/toltec-astro/tolteca_tutorials>`_  on
+GitHub. Please feel free to open issues or submit pull requests.
+
+For more information, please see the contributing documentation:
 
 .. raw:: html
 
     <a href="contributing.html"><button id="binder" style="background-color: #fa743b; border-color: #fa743b; margin-bottom: 1rem; cursor: pointer">How to contribute</button></a>
 
-For developers
---------------
 
-See the developer documentation: :ref:`dev-page`.
+Acknowledgement
+---------------
+
+* The TolTEC project is funded by the National Science Foundation, grant #1636621.
+
+* This site uses the HTML templates and infrastructure developed by `Learn Astropy <https://learn.astropy.org>`_.
+

tutorials/_static/toltec_logo_banner.png

@@ -0,0 +1,15 @@
+Recipes and Scripts
+===================
+
+Recipes are utility code snippets that comes as part of the
+`tolteca <https://github.com/toltec-astro/tolteca>`_ package,
+which implements a set of specific, high-level TolTEC data related tasks.
+
+Some of these tasks are used as part of the TolTEC data acquisition system,
+and some of them is used for operation and maintenance of the data archive.
+
+Recipes and scripts offer a command-line interface and the level of
+extensiveness of the documentation within each recipe/script may vary.
+
+See `tolteca/recipes <https://github.com/toltec-astro/tolteca/tree/master/tolteca/recipes>`_
+and `tolteca/scirpts <https://github.com/toltec-astro/tolteca/tree/master/tolteca/scripts>`_ for more details.

tutorials/documentation.rst

@@ -1,27 +1,21 @@
-{% if pagename == "index" or pagename == "search" or pagename == "tutorials" or pagename == "documentation" or pagename == "examples" or pagename == "guides" %}
-<!-- Learn astropy banner -->
+{% if pagename == "index" or pagename == "search" or pagename == "tutorials" or pagename == "documentation" or pagename == "recipes" or pagename == "guides" %}
+<!-- TolTEC banner -->
 <div class="container-fluid landing text-center">
-  <a href="/"><img src="_static/astropy_logo_banner.png" id="astropy-logo"></a>
+  <a href="/"><img src="_static/toltec_logo_banner.png" id="toltec-logo"></a>
   <form class="input-group col-sm-7 m-auto"  id="search-bar" action="{{ pathto('search') }}" method="get">
       <div class="input-group-prepend">
           <button class="input-group-text" type="submit"><i class="fa fa-search fa-fw"></i></button>
       </div>
-      <input type="text" name="q" id="search-bar-input" class="form-control" placeholder="Search the universe of Astropy" />
+      <input type="text" name="q" id="search-bar-input" class="form-control" placeholder="Search in TolTECA" />
   </form>
 </div>
 
 <!-- Guides, Tutorials, Examples, Documentation Placards -->
 <div class="container-fluid row definition-cards">
-  <div class="card bg-guide col-md-3 col-lg-2 p-0 m-2  ml-auto enable-guides">
-    <div class="card-body">
-      <h2 class="card-title text-center"><a href="{{ pathto('guides') }}" class="text-white">Guides</a></h2>
-      <p class="card-text text-center">Guides are comprehensive, conceptually-focused documents providing stand-alone introductions to core packages in addition to the underlying astronomical concepts.</p>
-    </div>
-  </div>
   <div class="card bg-tutorial col-md-3 col-lg-2 p-0 m-2 ml-auto">
     <div class="card-body">
-        <h2 class="card-title text-center"><a href="tutorials.html" class="text-white">Tutorials</a></h2>
-      <p class="card-text text-center">Tutorials are step-by-step cookbooks for common activities that incorporate several packages. They are more specific and less conceptual than Guides but more extended than Examples.</p>
+        <h2 class="card-title text-center"><a href="{{ pathto('tutorials') }}" class="text-white">Tutorials</a></h2>
+      <p class="card-text text-center">Tutorials are step-by-step cookbooks for common activities that incorporate several packages. They are more educational and interactive than recipes and scripts.</p>
     </div>
   </div>
   <div class="card bg-documentation col-md-3 col-lg-2 p-0 m-2">
@@ -32,24 +26,24 @@ <h2 class="card-title text-center" style="margin-left: -20px; margin-right: -20p
   </div>
   <div class="card bg-example col-md-3 col-lg-2 p-0 m-2 mr-auto">
     <div class="card-body">
-        <h2 class="card-title text-center"><a href="{{ pathto('examples') }}" class="text-white">Examples</a></h2>
-      <p class="card-text text-center">Examples are stand-alone code snippets that live in the astropy documentation that demonstrate a specific functionality within a package.</p>
+        <h2 class="card-title text-center"><a href="{{ pathto('recipes') }}" class="text-white">Recipes & Scripts</a></h2>
+      <p class="card-text text-center">Recipes and scripts are utility code snippets that accomplish specific, high-level data related tasks.</p>
     </div>
   </div>
 </div>
 
 {% else %}
 <nav class="navbar navbar-expand-lg bg-navbar">
   <a class="navbar-brand" href="/" style="padding: 0px 5px;">
-    <img src="{{ pathto('../_static/' + 'astropy_logo.png', 1) }}" onerror="this.onerror=null;this.src='{{ pathto("_static/" + "astropy_logo.png", 1) }}';" style="height: 38px;">
+    <img src="{{ pathto('../_static/' + 'toltec_logo.png', 1) }}" onerror="this.onerror=null;this.src='{{ pathto("_static/" + "toltec_logo.png", 1) }}';" style="height: 38px;">
   </a>
   <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarColor01" aria-controls="navbarColor01" aria-expanded="false" aria-label="Toggle navigation">
     <span class="navbar-toggler-icon"></span>
   </button>
   <div class="collapse navbar-collapse" id="navbarColor01">
     <ul class="navbar-nav ml-auto">
       <li class="nav-item active">
-        <a class="nav-link" href="http://www.astropy.org"/>Astropy<span class="sr-only">(current)</span></a>
+        <a class="nav-link" href="http://toltecdr.astro.umass.edu"/>TolTECA<span class="sr-only">(current)</span></a>
       </li>
       <li class="nav-item">
         <a class="nav-link" href="#">Modules</a>