Skip to content

Commit

Permalink
Added section for Bulk Editing.
Browse files Browse the repository at this point in the history
  • Loading branch information
bicarlsen committed Aug 20, 2021
1 parent 7824bc3 commit 697b23f
Show file tree
Hide file tree
Showing 9 changed files with 60 additions and 46 deletions.
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
sphinx-rtd-theme
recommonmark
sphinx_panels
sphinx-tabs
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/get_started/slack.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -172,4 +172,5 @@


# -- Extension configuration -------------------------------------------------

numfig = True
8 changes: 8 additions & 0 deletions source/get_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ To perform our analysis we’ll use Thot. Thot offers three interfaces: the **Co

Use Thot on the web for additional functionality.

(Coming soon)

+++

.. link-button:: web_basic
Expand All @@ -39,6 +41,12 @@ To perform our analysis we’ll use Thot. Thot offers three interfaces: the **Co
:text: Get Started
:classes: btn-outline-primary btn-block stretched-link

.. link-button:: https://join.slack.com/t/thotdata/shared_invite/zt-mnnm7pma-1X7rvNItxgN1MFfNmHhnwA
:type: url
:text: Join Our Community on Slack
:classes: btn-success btn-block


Thot Web
========

Expand Down
26 changes: 21 additions & 5 deletions source/get_started/local/containers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ Setting Up Your Project Tree

.. group-tab:: desktop



After installing the Thot Desktop app, run it. A folder browser will appear titled **Select Project Root**. This will set the root (top level) of our project.

.. figure:: /_static/get_started/local/root_selection.png
Expand Down Expand Up @@ -130,7 +128,6 @@ Setting Up Your Project Tree

============= =================
**Name:** Batch 1
**Type:** batch
**Metadata:** batch (number): 1
============= =================

Expand All @@ -140,7 +137,6 @@ Setting Up Your Project Tree

============= =================
**Name:** Batch 2
**Type:** batch
**Metadata:** batch (number): 2
============= =================

Expand All @@ -151,7 +147,7 @@ Setting Up Your Project Tree

Creating a child from the File Tree view

You may have noticed that Thot has added folders and files for us. This is how Thot keeps track of the structure of our projects. Each Container is actually just a filder with a file named ``_container.json`` inside of it. Feel free to explore these files or read the ``CLI`` sections for more information.
You may have noticed that Thot has added folders and files for us. This is how Thot keeps track of the structure of our projects. Each Container is actually just a folder with a file named ``_container.json`` inside of it. Feel free to explore these files or read the ``CLI`` sections for more information.

Great! We've now created our ``Recipe A`` branch, let's flip back to the **Project** view to visualize what we have. Wait... ``Batch 2`` isn't showing up. Let's refresh the project by clicking on the sync icon :fa:`sync-alt, style=fas` in the upper right of the wokspace.

Expand All @@ -162,6 +158,26 @@ Setting Up Your Project Tree

Project view after creating the Recipe A branch.


**Bulk Editing**

We forgot to assign a ``type`` to the batches. Luckily, we can do this easyily in one step. To select multiple resources from the Project view ``Ctrl (Cmd) + click`` them. Select ``Batch 1`` and ``Batch 2``. This opens the Bulk Editing menu. Click the ``Properties`` button and set the ``Type`` field. When bulk editing only fields that are set in the edit dialog will be changed. i.e. If you leave a field in the edit dialog blank that value will not be changed for any of the selected Containers or Assets.

.. figure:: /_static/get_started/local/bulk_edit_menu.png
:align: center
:alt: Bulk edit menu.
:figclass: align-center

Bulk edit menu.

.. admonition:: Try it!

Click on the ``<`` in the upper right hand of the Project view to open the Search and Select pane. See if you can select both Batches using this method.

**Tip:** Regular expressions are valid input.

**Tip:** The ``Metdata`` section should be a JSON object of key-value pairs or an array of keys.

Now let's create the ``Recipe B`` branch. We could go through the same process we did for ``Recipe A``, manually creating each Container. However, ``Recipe B`` is almost an exact duplicate of ``Recipe A``, so why don't we just copy it? Luckily, Thot Desktop gives us an easy way to do this.

Right click on the ``Recipe A`` Container and select ``Duplicate Tree``. This will copy the subtree you selected. Let's edit the name of the Container. Click on the pen icon :fa:`pen, style=fas` of the ``Recipe A (copy)`` Container and change its name to ``Recipe B`` and its metadata ``recipe`` to ``b``.
Expand Down
61 changes: 23 additions & 38 deletions source/get_started/local/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,60 +12,45 @@ To perform our analysis we'll use Thot. Thot offers three interfaces: the Comman
Getting Thot
************

Choose your interface
Thot requires Python (v3) which you can get from the `official Python site <https://www.python.org/downloads/>`_.

.. tabs::
After installing Python, you can install Thot and the CLI by running

.. group-tab:: desktop
.. code-block:: bash
Thot requires Python (v3) which you can get from the `official Python site <https://www.python.org/downloads/>`_.
python -m pip install thot-cli
After installing Python, you can install Thot by running
This will install both the ``thot-data`` and ``thot-cli`` packages.

.. code-block:: bash
**Desktop**

python -m pip install thot-data
#. Download the Thot Desktop app, following the links below:

#. Download the Thot Desktop app, following the links below:
* `Windows 10 <https://www.dropbox.com/sh/82zyipnf4giw7na/AABLx-ozn46hqPqU2PafLSnta?dl=0>`_
* `Mac Catalina <https://www.dropbox.com/sh/wo6pkc1bpptb2hz/AABelJU5JUVyvubUbH2zYT9Ma?dl=0>`_
* `Ubuntu 21+ <https://www.dropbox.com/sh/vh9f4f0pndcxxyl/AADC5gwLqbEJ7Nevaj1diVDPa?dl=0>`_
* `Ubuntu 20+ <https://www.dropbox.com/sh/nabl73zkiugxv6o/AADU820YeHbdz8MBk3pVJ1mSa?dl=0>`_
* `Ubuntu 16+ <https://www.dropbox.com/sh/dzekrad8lutr4wa/AADDDgI_aBH0ZvDmh-xOtgfga?dl=0>`_

* `Windows 10 <https://www.dropbox.com/sh/82zyipnf4giw7na/AABLx-ozn46hqPqU2PafLSnta?dl=0>`_
* `Ubuntu 20+ <https://www.dropbox.com/sh/nabl73zkiugxv6o/AADU820YeHbdz8MBk3pVJ1mSa?dl=0>`_
* `Ubuntu 16+ <https://www.dropbox.com/sh/dzekrad8lutr4wa/AADDDgI_aBH0ZvDmh-xOtgfga?dl=0>`_
#. Unzip the folder.
#. Install Thot Desktop

#. Unzip the folder.
#. Install Thot Desktop
* **Windows 10:** Run ``ThotDesktopSetup.exe``. If you get a security warning, click on the `More info` button, then click the `Run anyway` button that appears at the bottom.

* **Windows 10:** Run ``ThotDesktopSetup.exe``. If you get a security warning, click on the `More info` button, then click the `Run anyway` button that appears at the bottom.
* **Mac:** Double click on ``ThotDesktop.dmg`` then drag the ThotDesktop icon into the Applications folder.

* **Ubuntu:** From the terminal run
* **Ubuntu:** From the terminal run

.. code-block:: bask
.. code-block:: bask
sudo dpkg -i target/ThotDesktop.deb
sudo dpkg -i target/ThotDesktop.deb
.. note::
We will use Pandas for the analysis. To get Pandas you can `visit their website <https://pandas.pydata.org/getting_started.html>`_.
.. note::
We will use Pandas for the analysis. To get Pandas you can `visit their website <https://pandas.pydata.org/getting_started.html>`_.

.. seealso::
For additional functionality use our web verison.
.. seealso::
For additional functionality use our web verison.

.. group-tab:: cli

Thot requires Python (v3) which you can get from the `official Python site <https://www.python.org/downloads/>`_.

After installing Python, you can install Thot and the CLI by running

.. code-block:: bash
python -m pip install thot-cli
This will install both the ``thot-data`` and ``thot-cli`` packages.

.. note::
We will use Pandas for the analysis. To get Pandas you can `visit their website <https://pandas.pydata.org/getting_started.html>`_.

.. seealso::
For additional functionality use our web verison.

.. toctree::
:maxdepth: 1
Expand Down
2 changes: 1 addition & 1 deletion source/get_started/web/web-basic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Organizing Your Project

The first thing we need to do is organize our project. Thot uses a tree structure to organize your projects, giving your project different levels. The top level should be the most important grouping to you, becoming less important as you move down the tree.

For this project the most important thing we need to test is which recipe is quieter, so our top level grouping will be the recipes. Unfortunately, testing underwater fireworks happens to be quite expensive, so we will only be able to make two batches for each recipe. The batches will be our second level. This gives us the tree in :numref:`Fig. %s <fig_hosted_project_organization>`
For this project the most important thing we need to test is which recipe is quieter, so our top level grouping will be the recipes. Unfortunately, testing underwater fireworks happens to be quite expensive, so we will only be able to make two batches for each recipe. The batches will be our second level. This gives us the tree in :numref:`Fig. %s <fig_hosted_project_organization>`.

.. _fig_hosted_project_organization:

Expand Down
6 changes: 4 additions & 2 deletions source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Thot’s core principle is
Thinking About Thot
*******************

To achieve this core principle Thot uses **top-down organization** and **bottom-up analysis**, visualized in :numref:`Fig. %s <fig_organization_analysis_model>`. Another way to think about this is outside-in organization and inside-out analysis. This is implemented in a tree structure where each node has access to all the resources below it, and properties are inherited from above.
To achieve this core principle Thot uses **top-down organization** and **bottom-up analysis**, visualized in :numref:`Fig. %s <fig_organization_analysis_model_inside_out>`. Another way to think about this is outside-in organization and inside-out analysis. This is implemented in a tree structure where each node has access to all the resources below it, and properties are inherited from above.

.. _fig_organization_analysis_model:
.. _fig_organization_analysis_model_top_down:

.. figure:: /_static/overview/organization-analysis-model.png
:align: center
Expand All @@ -26,6 +26,8 @@ To achieve this core principle Thot uses **top-down organization** and **bottom-
:figclass: align-center
:class: no-scaled-link

.. _fig_organization_analysis_model_inside_out:

.. figure:: /_static/overview/organization-analysis-model-nested.png
:align: center
:width: 65%
Expand Down

0 comments on commit 697b23f

Please sign in to comment.