Skip to content

Commit

Permalink
Fixed typos.
Browse files Browse the repository at this point in the history
  • Loading branch information
bicarlsen committed Nov 7, 2020
1 parent dd0c75d commit a223d8d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
12 changes: 6 additions & 6 deletions source/get_started/hosted_project-basic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Edit Batch 1 setting its type to ``batch`` and adding a piece of metadata named

Click the :badge:`New Assets, badge-success` button, navigate to the project folder, and select the file ``a1-data.csv``. This creates an Asset for the data, and adds it to the Container. To access the Asset in our analysis script we'll find it by its type. To set this click on the down arrow :fa:`chevron-down` to open its editor. Double click on the (No type) text to open its type editor, and set it to `noise-data`. To save the changes you can either click on the :badge:`Save, badge-success` button, or press :kbd:`Shift + Enter`. To close the editor without saving press `Esc`. To minimize the Asset's editor click on the up arrow :fa:`chevron-up`.

Save the changes to Batch 1, and we'll now move on to Batch 2. This timem let's add the data in another way. Instead of doing it from Batch 2's editor, will do it directly from the Container Tree. Find the data file ``a2-data.csv`` and drag and drop it on to the Batch 2 Container. This adds an Asset for the data and adds it to te Container.
Save the changes to Batch 1, and we'll now move on to Batch 2. This time let's add the data in another way. Instead of doing it from Batch 2's editor, will do it directly from the Container Tree. Find the data file ``a2-data.csv`` and drag and drop it on to the Batch 2 Container. This adds an Asset for the data and adds it to the Container.

Open Batch 2's editor, set its type and add a piece of metadata similar to how we did for Batch 1. Be sure to change the metadata value to ``2`` though. We'll also set the type of the Asset exactly as we did for Batch 1.

Expand All @@ -81,7 +81,7 @@ Return to the Container Tree view by clicking on its icon :fa:`sitemap` in the t

Edit Recipe B > Batch 1 as before, setting its type to ``batch``, and adding a ``batch`` number metadata with value ``1``. Let's add our data Asset. Because it's already been added to the project all we have to do is associate it to the Container. Click on the :badge:`Add Asset, badge-success` button, and select it from the drop down list, then click the :badge:`Add Asset, badge-success` button again to add it. Save your changes as usual.

Finally let's edit Recipe B > Batch 2. Again setting it's type to ``batch``, adding a ``batch`` number metadata with value ``2``, and adding it's Asset. We also wan tot make a note here. Notes allow us to makes remarks directly on our data or analysis. On the day we fabricated this batch the humidity was a bit higher than usual, which we think may have affected the explosive powders. Click the :badge:`Add Note, badge-success` button to add a note. Title it ``Fabrication Humidity`` and make the note
Finally let's edit Recipe B > Batch 2. Again setting its type to ``batch``, adding a ``batch`` number metadata with value ``2``, and adding its Asset. We also want to make a note here. Notes allow us to makes remarks directly on our data or analysis. On the day we fabricated this batch the humidity was a bit higher than usual, which we think may have affected the explosive powders. Click the :badge:`Add Note, badge-success` button to add a note. Title it ``Fabrication Humidity`` and make the note

We noticed an elevated humidity during fabrication of this batch. While all the powders seem normal, it may have an influence on their performance.

Expand Down Expand Up @@ -121,22 +121,22 @@ Now that our project is all set up, let's finally analyze it. We can choose to a
Select its Container by single clicking on it. This activates some of the tools that were disabled before. Click on the Analyze button :fa:`chart-line`
. When the Analysis is done you'll see the new Asset show up in the preview panel on the right hand side of the screen.

Now let's analyze the whole Recipe A subtree. Open the Recipe A Container editor, and clcik on the :badge:`Analyze, badge-primary` button. Once the analysis is complete we will see the new Assets show up in the Assets section.
Now let's analyze the whole Recipe A subtree. Open the Recipe A Container editor, and click on the :badge:`Analyze, badge-primary` button. Once the analysis is complete we will see the new Assets show up in the Assets section.

Let open the Container editor for Recipe A. Here we see that we can download the entire container, which will also download all of its children. We can also download individual Assets.
Let's open the Container editor for Recipe A. Here we see that we can download the entire container, which will also download all of its children. We can also download individual Assets.

Click on the Batch 1 child to navigate to it. Here you'll see that we now have two versions of the Noise Statistics Asset that our script created. This is because the Noise Stats analysis ran twice on it: once when we analyzed Batch 1 itself, and again when we analyzed Recipe A. This is one of the key concepts in Thot -- analysis runs from the bottom of the tree upwards, allowing each higher level access to all the Assets below it.

Let's remove all the Assets we've created so far, then analyze the entrie project. Click on the trash can icon :fa:`trash` in the corner of the Asset preview card to remove it. You can navigate to Recipe A by scrolling to the top of the Container editor and clicking it in the breadcrumbs navigation, or by exiting the navigator and re-opening it for Recipe A. Let's also remove the Noise Stats Asset for Batch B.

Finally, let's analys the entire project. Select the Silent Fireworks Container, and analyze it. Let's download the entire project so we can browse all of our Assets. With the Silent Fireworks Container still selected, click the download icon :fa:`download`. Extract the zip file, and browse through the folders. When you download a Container it downloads it as a Local Thot project, which you can learn more about in the :ref:`Local Project: Basics <local_project_basics>` tutorial.
Finally, let's analyze the entire project. Select the Silent Fireworks Container, and analyze it. Let's download the entire project so we can browse all of our Assets. With the Silent Fireworks Container still selected, click the download icon :fa:`download`. Extract the zip file, and browse through the folders. When you download a Container it downloads it as a Local Thot project, which you can learn more about in the :ref:`Local Project: Basics <local_project_basics>` tutorial.

Take a look at the Recipe Comparison bar chart. Which recipe should we go with?

*******
Summary
*******

In this tutorial we learned the basics of creating and analyzing a Thot project. We began by creating a new project. We created our Container Tree, organizing our project. We added properties, notes, Assets, and Scripts to our Containers. We were able to add Assets both within the Container, and from the Project Assets view. To add Scripts we first added them in the Project Scripts view, then associated them to our desired Containers. Finally, we declared our project's dependencies in the Library view.
In this tutorial we learned the basics of creating and analyzing a Thot project. We began by creating a new project. We created our Container Tree, organizing our project. We added properties, notes, Assets, and Scripts to our Containers. We were able to add Assets both within the Container, and from the Project Assets view. To add Scripts we first added them in the Project Scripts view, then associated them with our desired Containers. Finally, we declared our project's dependencies in the Library view.

Once we saved our project we were taken to the Project view. From here we saw how we could modify our Containers, download Containers and Assets, and analyze our project.
14 changes: 7 additions & 7 deletions source/get_started/local_project-basic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ For this project the most important thing we need to test is which recipe is qui
Setting Up Your Project Tree
****************************

Local projects use your file system as a database. We will begin by making a folder for the project. Let's call it ``fireworks``. One of the main philosphies behind Thot is that data and analysis should be separate. Let's reflect this in our project by creating a ``data`` folder and a ``analysis`` folder.
Local projects use your file system as a database. We will begin by making a folder for the project. Let's call it ``fireworks``. One of the main philosophies behind Thot is that data and analysis should be separate. Let's reflect this in our project by creating a ``data`` folder and an ``analysis`` folder.

We will build our project tree in two ways. First, we'll create the tree for Recipe A by hand, to get a sense of how Thot uses our folders as a database. And second, we will use Thot's Utilities package to build the tree for Recipe B, automating the process.

Expand Down Expand Up @@ -270,7 +270,7 @@ Let's go through and break down what each chunk of code is doing.
.. * - Line No.
.. - Description
.. * - 2-3
.. - Import the packages we're goin to use, namely Pandas and Thot. In this case we only need to use a small part: LocalProject.
.. - Import the packages we're going to use, namely Pandas and Thot. In this case we only need to use a small part: LocalProject.
.. * - 6
.. - Initialize the Thot project, giving us access to all the data stored within it.
.. * - 9
Expand All @@ -280,7 +280,7 @@ Let's go through and break down what each chunk of code is doing.
.. * - 15
.. - Compute statistics on the noise data.
.. * - 18-24
.. - Create a new Asset to store the noise statistics in. Notice that the ``stats_properties`` dictionary we pass in mimics exactly the structure of the ``_asset.json`` files we created earlier. ``thot.add_asset()`` accepts as it's second argument an ``_id`` for the new Asset.
.. - Create a new Asset to store the noise statistics in. Notice that the ``stats_properties`` dictionary we pass in mimics exactly the structure of the ``_asset.json`` files we created earlier. ``thot.add_asset()`` accepts as its second argument an ``_id`` for the new Asset.
.. * - 27
.. - Save the statistics to the new Asset.
Expand Down Expand Up @@ -329,7 +329,7 @@ You should see the ``noise_stats`` Asset be added to the folder. Great! Now let'
You'll notice that we replaced the ``--search`` flag from the previous command like this with the ``-s`` flag. The two are synonyms for each other, ``-s`` just giving us a shorthand for ``--search``.

Now let's analyze the entrie project by running ``python -m thot.runner`` again. This will create a new Noise Statistics Asset for each of the batches.
Now let's analyze the entire project by running ``python -m thot.runner`` again. This will create a new Noise Statistics Asset for each of the batches.

.. only:: builder_html or readthedocs

Expand Down Expand Up @@ -376,9 +376,9 @@ Let's breakdown the new concepts:

+ **line 14:** Use the recipe metadata from the Asset to name the data.

+ **line 28, 44:** We;ve already seen that we can pull in multiple Assets into our scripts. here we also see that we can create multiple Assets in a single script. Also notice that one Asset is a CSV text file, while the other is a PNG image file. Assets can be any sort of file.
+ **line 28, 44:** We've already seen that we can pull in multiple Assets into our scripts. Here we also see that we can create multiple Assets in a single script. Also notice that one Asset is a CSV text file, while the other is a PNG image file. Assets can be any sort of file.

Add the proper Script Association (``_scripts.json``) to the root folder, and analyze the project. Take a look at the Assets we created so we know which recipe is quiter.
Add the proper Script Association (``_scripts.json``) to the root folder, and analyze the project. Take a look at the Assets we created so we know which recipe is quieter.

Congratulations! You just built your first Thot project, building it from scratch and analyzing the data to come to a final conclusion. We've only touched on the functionality of Thot, and with such a small project it's hard to get a sense of the power thot gives you in analyzing larger projects. To learn more about this you can go through the advanced tutorial (coming soon) and learn even more.

Expand All @@ -402,7 +402,7 @@ Here are the most important concepts and commands we learned through this tutori
Containers
----------

+ A Conatainer is a folder with a ``_container.json`` file in it. Containers can container other Containers, Assets, and Script Associations.
+ A Container is a folder with a ``_container.json`` file in it. Containers can contain other Containers, Assets, and Script Associations.

.. code-block:: JSON
:caption: Basic ``_container.json`` file.
Expand Down

0 comments on commit a223d8d

Please sign in to comment.