{"_id":"5a009eabc69c2b0024a49612","project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":35,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295","5a009de510890d001c2aabfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"category":{"_id":"5a009de510890d001c2aabfe","project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-11-06T17:37:41.594Z","from_sync":false,"order":3,"slug":"gbdx-notebooks","title":"GBDX Notebooks"},"user":"55fae9d4825d5f19001fa379","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-06T17:40:59.827Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"# Contents\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Table of Contents\",\n    \"0-0\": \"[Getting Started](#section-getting-started)\\n[Navigating GBDX Notebooks](#section-navigating-gbdx-notebooks)\\n[My Library](#section-my-library)\\n[Discover](#section-discover)\\n[Create New Notebook](#section--create-new-notebook)\\n[Documentation](#section-documentation)\\n[Notebook Details Page](#section-notebook-details-page)\\n[Creating a New Notebook](#section-creating-a-new-notebook)\\n[GBDX Notebook Tutorials](#section-gbdx-notebook-tutorials)\\n[Deploying Tasks](#section-deploying-tasks)\\n[Running Tasks](#section-running-tasks)\\n[Publishing a Notebook](#section-publishing-a-notebook)\\n[Privacy and Sharing](#section-privacy-and-sharing)\\n[Feedback and Support](#section-feedback-and-support)\"\n  },\n  \"cols\": 1,\n  \"rows\": 1\n}\n[/block]\n# Getting Started\n\n##Prerequisites\n\nTo sign in to GBDX Notebooks, these are required:\n\nAccount | Description\n--- | ---\nA GBDX User Account | If you're already a GBDX user, you'll log into GBDX Notebooks with the same account credentials. If you're new to GBDX, you can create an account from within GBDX Notebooks.\nA Github Account | We link to your GitHub account so you can publish Gists and share notebooks with groups and organizations that may already exist in your GitHub accounts. You'll only need to link your accounts on your first login.\n\n## Sign in to GBDX Notebooks\n\nTo sign in or create a new GBDX account, go to https://notebooks.geobigdata.io . Click the \"Log in or Sign Up\" button at the top right of the screen. The sign in box will appear.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9380e68-Screen_Shot_2017-11-17_at_3.47.35_PM.png\",\n        \"Screen Shot 2017-11-17 at 3.47.35 PM.png\",\n        325,\n        396,\n        \"#ececeb\"\n      ],\n      \"caption\": \"Log in with your GBDX User Account credentials.\"\n    }\n  ]\n}\n[/block]\nOnce you sign in to GBDX Notebooks, you'll be prompted to agree to the GBDX Terms of Use. enter your Github account credentials. \n\n## Connect your Github Profile\n\nNext, you'll be prompted to connect your GitHub profile. If you don't have one, you can create one from this menu.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/3673b93-GBDX_Notebooks_Connect_to_Github_profile.png\",\n        \"GBDX Notebooks Connect to Github profile.png\",\n        690,\n        260,\n        \"#dcd9d2\"\n      ],\n      \"caption\": \"Connect your GitHub profile to GBDX Notebooks, or create a GitHub profile if you don't have one.\"\n    }\n  ]\n}\n[/block]\nOnce you click \"connect\", your GBDX and GitHub accounts will be connected.\n\n# Navigating GBDX Notebooks\n\nGBDX Notebooks is organized into four top level sections. Use the top navigation menu to visit each section. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b7ef218-Top_Navigation_Bar.png\",\n        \"Top Navigation Bar.png\",\n        780,\n        69,\n        \"#04365e\"\n      ],\n      \"caption\": \"GBDX Notebooks top navigation menu\"\n    }\n  ]\n}\n[/block]\nName | Description\n--- | ---\nMy Library | Click \"My Library\" to see the library of Notebooks you've created. \nDiscover | Explore published Notebooks, and clone and edit publicly available Notebooks you want to try out. \n+New Notebook | Create a new Notebook using the \"New Notebook\" tutorial, or start from a blank Notebook.\nDocumentation | This link directs you back to the GBDX Notebooks user documentation. \n\n\n# My Library\n\n\"My Library\" displays the Notebooks you've created. From this page, edit, duplicate, or delete a Notebook. \n\nFilter your view by selecting one of the links to the right of the word \"Notebooks\".\n\nView | Description\n--- | ---\nAll | Choose \"All\" to see your drafts and published Notebooks\nDrafts | Choose \"Drafts\" to see only your Notebooks that have not been published yet. \nPublished | Choose \"Published\" to see only Notebooks that you have published.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e377a09-My_Library_22All22_view.png\",\n        \"My Library %22All%22 view.png\",\n        1065,\n        479,\n        \"#eaeaea\"\n      ],\n      \"caption\": \"\\\"My Library\\\" page, with the \\\"All\\\" view selected. This view shows all drafts and published Notebooks.\"\n    }\n  ]\n}\n[/block]\n## Notebook Cover Information\n\nThe \"My Library\" page displays a \"cover\" view of each of your Notebooks. Each cover provides basic information about the Notebook, and allows the user to take a series of actions.\n\nInformation | Description\n--- | ---\nName | The name given to the Notebook by the author\nAuthor | The Username of the Notebook's author\nPermissions | The permissions levels are \"public\" and \"private\". The default is \"public\".\nDate and Time | The date and time the Notebook was published.\nCover Image | Displays the image provided by the Notebook's author.\nTags | The tags provided by the Notebook's author. These tags are searchable from the \"Discover\" section. Tags only appear on the cover once the Notebook has been published.\nDescription | The short description provided by the Notebook's author. \nDraft | If the Notebook has not been pulished, the cover will show \"draft\", and the description will be \"Not published yet.\"\n\n## Notebook Cover Actions\n\nFrom the Notebook cover, the following actions can be executed:\n\nAction | Description\n--- | ---\nEdit | Edit the content of an existing Notebook.\nDuplicate | Make a copy of a Notebook in your library. By default, the duplicated version will be given the same name, with a \"-1\" appended to it. The number will increase each time the Notebook is duplicated. See the example below.\nDelete | Delete the Notebook. This will delete the contents and cover.\nDetails | Click \"Details\" to view the code and output of a Notebook. Metadata can be updated from the details page by clicking the pencil icon next to the name. Notebook content is not editable in this view. The \"Details\" button is only available for \"published\" Notebooks. \n\n### \"Duplicate\" Naming Convention\n\nExample: \nOriginal: Simple_Change_Detection\n\nDuplicate 1: Simple_Change_Detection-1\n\nDuplicate 2: SImple_Change_Detection-2\n\nThe name can be changed from within the Notebook. Click on the name at the top of the page, and the \"Rename Notebook\" box will pop up.\n\n# Discover\nThe \"Discover\" page lets you browse tutorials, search and explore published Notebooks, and clone and edit a public Notebook.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/c3dcf87-Explore_Notebooks_Screenshot.png\",\n        \"Explore Notebooks Screenshot.png\",\n        1017,\n        802,\n        \"#19577e\"\n      ],\n      \"caption\": \"From the Discover page, you can search for, clone, and edit public Notebooks, View Notebook tutorials, and see newly published Notebooks.\"\n    }\n  ]\n}\n[/block]\n## Explore Notebooks\nThe \"Explore Notebooks\" search feature lets you search for public Notebooks that meet your needs. When you type a word or phrase into the search box, our search engine looks for a full or partial match in the following fields:\n\n*  Name\n* Author name\n* Tags\n* Description\n\n## Notebook Tutorials\n\nThe \"Notebook Tutorials\" section displays collections of tutorials. A collection is a group of tutorials that fall into the same category. Select the collection to view the Notebooks within it. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d0381a5-Notebook_tutorials.png\",\n        \"Notebook tutorials.png\",\n        1027,\n        197,\n        \"#165a86\"\n      ],\n      \"caption\": \"Notebook tutorials are organized into \\\"collections\\\".\"\n    }\n  ]\n}\n[/block]\nThese Notebooks tutorials will walk you through the basics on how to access imagery, and perform various operations against that imagery. The Notebooks are a great way for users to interact with the data with Python, and to learn about the structure and capabilities of DigitalGlobe imagery. \n\nFor further documentation on \"gbdxtools\", a Python=based tools suite for interacting with GBDX, see [gbdxtools documentation] (http://gbdxtools.readthedocs.io/en/latest/).\n\n\n\n## Newly Published Notebooks\nThis section displays Notebooks that have been published recently. The newest Notebooks are displayed first. \n\n## Search Results\nOnce a search is executed, the set of Notebook covers that match the search criteria will be returned. Only publicly available Notebooks are returned. \n\n## Notebook Covers\n\n###Notebook Cover Information\nFrom this view, the Notebook cover shows the following details:\n\nInformation | Description\n--- | ---\nName | The name given to the Notebook by the author\nAuthor | The Username of the Notebook's author. Click on the author's name to see other Notebooks they've authored.\nPermissions | Only Notebooks with permissions set to \"public\" appear in this view. \nDate and Time | The date and time the Notebook was published.\nCover Image | Displays the image provided by the Notebook's author.\nTags | The #tags provided by the Notebook's author. These tags are searchable from the \"Discover\" section. \nDescription | The short description provided by the Notebook's author. \n\n### Notebook Cover Actions\n\nFrom this view, the following actions can be executed:\n\nAction | Description\n--- | ---\nDetails | Select \"Details\" to view the code and output of a Notebook. Content is not editable in this view. \nClone and Edit | Selecting the \"Clone & Edit\" button will create a copy of the Notebook in your own Jupyter Notebook environment. From there you can rename the Notebook, interact with the code, add new code, change the Area of Interest, and more. When you're ready, you can publish the Notebook. \n\n\n# Create New Notebook\n\nThis page lets you create a new Notebook. There are two options available for Notebook creation: \n\nOption | Description | Notes\n--- | --- | ---\nStart with Imagery | This option opens an introductory tutorial with imagery and code samples. This option is ideal for first-time users. | Recommended\nBlank | This option opens a new Notebook with no code snippets or imagery. To use this option, you'll find imagery by using the AOI selection tool, and create your Python analysis from scratch. | Advanced\n\n# Documentation\nThe Documentation link brings you back to the documentation you're reading now. You can easily access the GBDX Notebooks course from this link, or from the sidebar navigation on GBDX University. \n\nGBDX Notebooks tutorials are available from within the application. For example, to see the tutorial \"Introduction to Image Access with GBDXTools\", Choose \"New Notebooks\", and then \"Start with Imagery\". Other tutorials can be accessed from the \"Discover\" page.\n\n# Notebook Details Page\n\nView the Notebook details page by clicking the Notebook title or the \"Details\" button from the Notebook cover. \n\n## View the Notebook Cover Information\nAt the top of the Notebook details page, you can view the following:\n* Title\n* Publisher \n* Public or Private\n* Cover image\n* Published Date\n* Description\n* Searchable tags\n\n## Clone and Edit\nThe \"Clone & Edit\" button is available from the top of the Notebook Details Page. This button lets you clone a public Notebook, and then edit the contents of the copy. \n\n## Interact with the Code\n\nSelect \"Code\" to see the code used to create the Notebook in \"read-only\" mode. In this view, you'll see the main description, the section descriptions, the input code blocks, and the output of each section. \n\n## View Outputs\n\nSelect \"Outputs\" to see only the outputs of the Notebook. In this view, the code blocks are not displayed. \n\n# Creating a New Notebook\n\nTo create a new Notebook, select \"+New Notebook\" from the top navigation bar. You can select one of the following ways to start your new Notebook:\n\n* Start with Imagery: This option opens an editable tutorial in your Juypter Notebooks environment. The tutorial walks you through selecting imagery and adding code to your Notebook. For first time users, we recommend this option. \n\n* Blank: This option opens a blank Notebook with no tutorials. You'll use the \"imagery\" tool on the left sidebar to select imagery.\n\nOnce you start to create a new Notebook, you'll notice some differences between your GBDX Notebook and a standard Jupyter Notebook. While the default Notebook behavior is as standardized as possible, we've made changes to streamline your access to DigitalGlobe's imagery catalog.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b4de49b-Insert_record.png\",\n        \"Insert record.png\",\n        1174,\n        625,\n        \"#ededec\"\n      ]\n    }\n  ]\n}\n[/block]\n## GBDX Notebooks Custom Toolbar\n\nThe custom GBDX Notebooks toolbar will be displayed on the left side of the page. The toolbar offers the following options:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ef881b6-Screen_Shot_2018-01-05_at_10.58.36_AM.png\",\n        \"Screen Shot 2018-01-05 at 10.58.36 AM.png\",\n        60,\n        102,\n        \"#19a2da\"\n      ],\n      \"caption\": \"GBDX Notebooks custom toolbar\"\n    }\n  ]\n}\n[/block]\nTool or Link | Description\n--- | ---\nImagery | The \"imagery\" icon opens the Area of Interest selection tool. Use this tool to search for imagery and create and save an Area of Interest. \nDeploy | Notebooks can be deployed as \"tasks\". The \"Deploy\" icon opens a form page where you'll input your task information and add your input and output requirements. From here, select \"Publish\" to deploy the task.\n\n## Select an Area of Interest (AOI)\n\nSelect the \"Imagery\" icon from the sidebar to open the AOI selection tool. \n\nGBDX Notebooks are designed to give access to small AOIs for users to build their methods and algorithms against. The AOI selection tool is zoom-level dependent. The red bar at the bottom of the map lets you know the AOI you've selected is too large. Keep zooming in until the bar turns green. Once the bar turns green, the text will say \"Draw a rectangle to select an area of interest.\"\n\n### Narrow your Search Area\nTo start a search, we recommend typing a location in the search box. It can be a general area, such as \"Denver\" or a more specific area such as Denver International Airport, Denver, CO. Be as specific as possible to narrow your search.\n\nTo zoom in or out to change your AOI, you can:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": []\n    }\n  ]\n}\n[/block]\n* Use the +(plus) button to zoom in, or the -(minus) button to zoom out. \n* Double click the left mouse button to zoom in.\n* Scroll your mouse wheel down to zoom in, and up to zoom out.\n\n\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/f8ac71d-AOI_Selection_-_Red_Bar.png\",\n        \"AOI Selection - Red Bar.png\",\n        531,\n        913,\n        \"#35421d\"\n      ],\n      \"caption\": \"In this example, the AOI is too large to allow imagery selection. The user will need to continue to zoom in to a smaller area. When the area is small enough, the zoom bar will turn green.\"\n    }\n  ]\n}\n[/block]\n### Select an AOI\nOnce you have zoomed in to a small enough area, draw a polygon around the specific area to create an AOI. There are two ways to draw a polygon:\n\n* Select the polygon icon, then click the starting location for your area. Draw and connect each side of your polygon.\n\n* Select the square icon. Click the start location for the square, then drag to create the boundaries. \n\nOnce an area has been selected, the bounding box is shown in the green bar. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ca679b2-Screen_Shot_2017-11-17_at_12.52.40_PM.png\",\n        \"Screen Shot 2017-11-17 at 12.52.40 PM.png\",\n        1052,\n        1464,\n        \"#747264\"\n      ],\n      \"caption\": \"\"\n    }\n  ]\n}\n[/block]\nOnce you select an AOI, the search button at the bottom of the screen will be enabled. Select this button to execute a search. You can set search filters to narrow your results.\n\n### Selecting Filters\nTo set search filters before executing a search, click \"Search Filters\" in the lower left corner of the pane. \n\nWhen a search is executed, the search results pane is displayed. A horizontal scrolling selector is displayed for each filter. Once the filters are set, select the \"search\" button to execute the search.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2e9499a-Screen_Shot_2017-11-17_at_1.02.35_PM.png\",\n        \"Screen Shot 2017-11-17 at 1.02.35 PM.png\",\n        1046,\n        1032,\n        \"#747263\"\n      ],\n      \"caption\": \"Drag the control to the left or the right to change the filter values.\"\n    }\n  ]\n}\n[/block]\n### AOI Search Results\n\nWhen a search is executed, the image count is displayed at the top of the screen, and the results display at the bottom of the pane. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/c4ff962-Screen_Shot_2017-11-17_at_12.38.46_PM.png\",\n        \"Screen Shot 2017-11-17 at 12.38.46 PM.png\",\n        1032,\n        1600,\n        \"#7a775c\"\n      ],\n      \"caption\": \"There are 46 images in this results set.\"\n    }\n  ]\n}\n[/block]\nTo narrow the results set further, choose \"Additional Filters\" in the top left corner of the pane. This brings up the filter box, and the filters can be changed using the horizontal scroll bar.\n\n\n#### Available Imagery\n *Data Sources*: GBDX Notebooks have access to WORLDVIEW-2 AND WORLDVIEW-3 products.\n\nGBDX Notebooks searches for products that are already available in the GBDX catalog. If an  image is not available, it can be ordered through GBDX. Once an order is delivered to the GBDX catalog, the image will be available in GBDX Notebooks. See [Ordering Course v2](doc:ordering-course-v2)  or [Ordering Imagery using gbdxtools](http://gbdxtools.readthedocs.io/en/latest/user_guide.html?highlight=order#ordering-imagery) for information on how to place an order. \n\n\n\n#### Search Results View\n\nThe Search Results view displays the following for each record:\n\nItem | Description\n--- | ---\nCheckbox | Click to check the box next to a record. Clicking the box activates the \"insert code\" button in the lower right corner. \nDate | The date the image was acquired by the satellite.\nCoverage | Each record is part of the specific AOI you defined; not part of a full image strip. Coverage shows how much overlap exists between your AOI and the strip. 100% means that the image covers the entire AOI you selected. \nSource | The source is the satellite that acquired the image.\nClouds | The percentage of cloud cover in the image. This will help you determine if the image will be useful or not. \nPreview | Preview lets you view the image before adding it to your Notebook. \nInsert | Selecting \"Insert\" adds the image request code to your Notebook, and fetches the image for preview. \n\n\n#### Preview an Image\n\nSelecting \"Preview\" displays the image and its metadata. If you need to find the catalog ID for an image, it's listed in this view. \n\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/af93230-Screen_Shot_2017-11-17_at_2.56.18_PM.png\",\n        \"Screen Shot 2017-11-17 at 2.56.18 PM.png\",\n        508,\n        530,\n        \"#595e4b\"\n      ],\n      \"caption\": \"The preview pane shows the select image and its associated metadata.\"\n    }\n  ]\n}\n[/block]\n#### Insert a Single Image\nOnce you find an image you want to add to your Notebook for processing, click \"insert\"  from the individual record in the search results, or in the preview pane. This will insert the cell for importing the image into the Notebook, and fetch the image. The cell gives key information about the image, and lets you begin analyzing the imagery. From this cell, you can find the catalog ID and bounding box. It has also plotted the multispectral band for the image. \n\nMany published and publicly available Notebooks have a cell like this as the first cell in the Notebook. You can insert your own cell into the Notebook. This will allow the Notebook to work on the AOI you've selected instead of the AOI included by the original author. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/669abc5-Insert_Record2.png\",\n        \"Insert Record2.png\",\n        1199,\n        638,\n        \"#ededec\"\n      ],\n      \"caption\": \"This is the result of \\\"inserting\\\" an image from the AOI selector.\"\n    }\n  ]\n}\n[/block]\n#### Insert Code for Multiple Images\n\nTo insert multiple images at once, click the check box next to each image you want to insert. This will activate the \"Insert Code for [number] Images\" button. \n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/586cd7e-insert_code_for_multiple_images.png\",\n        \"insert code for multiple images.png\",\n        508,\n        356,\n        \"#0da3dd\"\n      ]\n    }\n  ]\n}\n[/block]\nWhen you insert code for multiple images at once, the result is a code snippet containing a JSON file. The JSON file contains pointers to all the images you selected. \n\nUsing multiple images can be necessary when working with time series, working with change detection, creating mosaics, or anything else you can come up with. For more details on using the notebooks, and interacting with DigitalGlobe imagery you can access our Notebook tutorials, which will walk you through other common operations such as working with the various imagery bands, reprojecting the images, and viewing the full metadata. \n\n# GBDX Notebook Tutorials\n\nThe GBDX Notebooks Tutorials are the best way to learn how to add capabilities to your Notebook with Python. \n\nThis is an example of a GBDX Notebooks tutorial.\nhttps://notebooks.geobigdata.io/hub/notebooks/5a05ecba89e0d2084815bc5a\n\nTutorial Notebooks can be cloned, and then edited for your own use. \n\n# Deploying Tasks\nOnce you've created a Notebook that performs as you expect it to over a small AOI, you can scale your Notebook over much larger areas by deploying it as a GBDX task. This is a quick and easy way to deploy a task on the GBDX platform, without having to deploy it in a Docker container. This removes much of the overhead work of task deployment.\n\nTo deploy a task, click the \"Deploy\" icon from the toolbar. This will open a new pane. In this pane, you'll add input variables, output variables, and task information.\n\n## Inputs\nIn the example below, this Notebook requires two catalog IDs, a \"before\" image and an \"after\" image, as well as a bounding box. These fields are populated into the ‘Deploy’ tab by looking for variables within the Python code you’ve written in your Notebook. You must have successfully executed a cell using that variable in order for it to show up as an option for the input. You can then use the drop downs under ‘Type’ to specify what type of variable this is. \n\n## Outputs\nOutputs work in the same way. Variables that were specified within the Notebook will appear here. In this example we have a variable called ‘total_feaures’ which will output a string with the number of tents that were detected within the bounding box, as well as an output file, which will be output as a GeoJSON file. \n\n## Task Metadata\nAfter you've specified your required inputs and outputs, you can give your task a name, description, and version number. Once you’ve deployed this task it will be available to run in your Notebook, or directly from \"gbdxttools\". \n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/3eb122a-Deploy_Tasks_image.png\",\n        \"Deploy Tasks image.png\",\n        1600,\n        809,\n        \"#eeefef\"\n      ]\n    }\n  ]\n}\n[/block]\n## Publish\nOnce all the information has been populated, click the \"publish\" button to deploy your task. \n\n## View your Deployed Tasks\nOnce you have \"published\" or \"deployed\" a task, it will appear in the \"Deployed Tasks\" List. The task will first appear in \"pending\" state. This means it's in the process of being published. Once deployment is complete, a \"run\" button will appear next to the task. \n\n### Example 1: Deployed Task in \"Pending\" State\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0be0c9c-My_Tasks_1.png\",\n        \"My Tasks 1.png\",\n        1044,\n        333,\n        \"#405b5f\"\n      ],\n      \"caption\": \"Select \\\"Deployed Tasks to see a list of tasks published by you. The task in this example has just been deployed, and is still in the \\\"pending\\\" state.\"\n    }\n  ]\n}\n[/block]\n### Example 2: Deployed Task in \"Run\" State\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a649053-task_logs.png\",\n        \"task logs.png\",\n        1018,\n        540,\n        \"#50504a\"\n      ],\n      \"caption\": \"This example shows the same task once deployment is complete. The \\\"run\\\" button is now available, which allows you to run the task.\"\n    }\n  ]\n}\n[/block]\n### Deployed Task States\n\nState | Description\n--- | ---\nPending | The task deployment is running, but is not complete. Deployment can take up to 10 minutes.\nRun | Task deployment is complete. The task is now available to \"run\". \n\n### Deployed Task List Details\n\nFrom the \"Deployed Tasks\" list, the following is displayed for each task:\n\n* Task Name\n* Version\n* Notebook Name\n* Description\n* \"Move to Trash\" icon\n\n# Running Tasks\nOnce you click the \"Run\" button next to a task, you'll be able to run your task on GBDX at scale. \n\nTo run a task from the \"Deployed Tasks\" list: \n\n1. Select the \"Run\" button to the right of the task\n2. Add the required inputs. These are the inputs you defined when deploying the task. \n3. Click the \"Run Task\" button\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d86aa1d-Run_Task.png\",\n        \"Run Task.png\",\n        1004,\n        874,\n        \"#287c98\"\n      ],\n      \"caption\": \"In this example, this task requires 2 catalog IDs and a bounding box. Input this information in the correct boxes, and then select \\\"Run Task\\\".\"\n    }\n  ]\n}\n[/block]\n## Task Run History\n\nSelecting \"Run Task\" adds your task to the GBDX queue. When a task is submitted to the queue, a \"Task Run History\" line item is displayed for the task. The \"Task Run History\" shows:\n\n* Date and Time submitted\n* A \"Logs\" button\n* An \"Output\" button (this button is grayed out until the task is complete).\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/dc97695-my_tasks_3.png\",\n        \"my tasks 3.png\",\n        1010,\n        436,\n        \"#d3dee0\"\n      ],\n      \"caption\": \"This example shows the \\\"Task Run History\\\" for the deployed task.\"\n    }\n  ]\n}\n[/block]\n### Task Logs\n\nThe \"logs\" section lets you check the status of your task,. From this view, you can see the tasks' events and states, along with any errors encountered during the task run.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/73da2a3-task_logs.png\",\n        \"task logs.png\",\n        1018,\n        540,\n        \"#50504a\"\n      ]\n    }\n  ]\n}\n[/block]\n### View Task Output\n\nOnce the task has finished running, the \"Output\" button will become active. Selecting this button will show you the outputs you specified when deploying the task. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9ac5dca-Task_Output.png\",\n        \"Task Output.png\",\n        1600,\n        797,\n        \"#eae5e2\"\n      ],\n      \"caption\": \"This example shows the output of the Tent Counting algorith. The outputs are a feature count of 6,837 tents and a viewable GeoJSON file. You can now continue working with the GeoJSON in the Notebook, or view the results on a slippy map.\"\n    }\n  ]\n}\n[/block]\nUsing the ‘Deployed Tasks\" tab is the fastest and easiest way to scale up an arbitrary analysis you’ve created in your Notebook. Once you’ve created the task, it's simple to run it on other areas. You can run the same task with new Catalog IDs and a new bounding box. You can also specify multiple Catalog IDs to deploy your tasks at massive scales.\n\n# Publishing a Notebook\nPublishing your Notebook allows you to share it with the community or with other users privately. Once a Notebook is published, it appears in the list on the \"Discover\" page. \n\nOnce your Notebook is ready to be shared, click the \"Publish Notebook\" button.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d78533e-publishing_Notebooks.png\",\n        \"publishing Notebooks.png\",\n        1600,\n        674,\n        \"#0a4771\"\n      ],\n      \"caption\": \"Click \\\"Publish Notebook\\\" to make your Notebook available for sharing.\"\n    }\n  ]\n}\n[/block]\n# Privacy and Sharing\n\n## Private and Public Notebooks\nWhen a Notebook is published, it can be set to \"private\" or \"public\". \"Public\" Notebooks are viewable to all users from the \"Discover\" page. \"Private\" Notebooks can be set to be available only to you, or to a GitHub organization or group. \n\n## Change Permissions Settings on a Notebook\n\nPermissions can only be set on Notebooks that have been published. The default permissions setting is \"Public\".\n\nTo change the permissions settings for a Notebook, do the following:\n\n1. From \"My \"Library\", find the Notebook you want to update\n2. Click the \"Details\" button on the Notebook cover (if the task has not been published yet, the \"details\" button will not appear). \n3. From the \"details\" page, click the pencil icon next  to the name. This will bring up a dialog box.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/c6a533c-Screen_Shot_2017-11-21_at_11.15.27_AM.png\",\n        \"Screen Shot 2017-11-21 at 11.15.27 AM.png\",\n        1094,\n        209,\n        \"#f3f3f3\"\n      ],\n      \"caption\": \"Click the pencil icon next to the name to update Notebook metadata and change the privacy settings.\"\n    }\n  ]\n}\n[/block]\n4. From this dialog box, you can update the Notebook's metadata, \"unpublish\" the Notebook, or change Permissions. Select \"Permissions\" to change the setting.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a1c1756-Screen_Shot_2017-11-21_at_11.16.38_AM.png\",\n        \"Screen Shot 2017-11-21 at 11.16.38 AM.png\",\n        1041,\n        328,\n        \"#f1f1f1\"\n      ],\n      \"caption\": \"Select \\\"Permissions\\\" to change the setting from public to private, and to share the Notebook with a group or organization.\"\n    }\n  ]\n}\n[/block]\n5. From the \"Global Permissions\" page, select \"Public\" or \"Private\". If you select \"Private\", additional \"Private\" settings will be enabled. \n\n6. To keep the Notebook private to you only, no other selections need to be made.\n\n7. To keep the Notebook private, but share with your GitHub organization or group, choose the edit buttons and make a selection from the available options. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/aa153d5-Screen_Shot_2017-11-21_at_11.17.47_AM.png\",\n        \"Screen Shot 2017-11-21 at 11.17.47 AM.png\",\n        1366,\n        420,\n        \"#376c91\"\n      ]\n    }\n  ]\n}\n[/block]\n8. Once you've added or updated the metadata and privacy settings, select \"publish\" in the bottom right corner. \n\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fe5e811-share_your_notebook.png\",\n        \"share your notebook.png\",\n        1600,\n        675,\n        \"#f1f1f1\"\n      ],\n      \"caption\": \"Click \\\"publish\\\" to publish the metadata that accompanies your Notebook.\"\n    }\n  ]\n}\n[/block]\n## Cancel Publishing\nYou can cancel publishing by clicking the \"Cancel Publishing\" button on page shown above. This button only appears when the Notebook has already been published. \n\n## Publish Notebook as a gist\nOur hosted Notebooks have integrated access to publishing your Notebook as a [gist](https://help.github.com/articles/about-gists/). Click on the small arrow next to the ‘CellToolbar’ to automatically publish the Notebook you’re currently working in as a Gist, which can be accessed through your GitHub account.\n\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1fb3ff8-Notebook_as_a_Gist.png\",\n        \"Notebook as a Gist.png\",\n        1600,\n        286,\n        \"#eff0ef\"\n      ]\n    }\n  ]\n}\n[/block]\n##Jupyter Notebooks\nTo learn more about Jupyter Notebooks, see [Jupyter Documentation](https://jupyter.readthedocs.io/en/latest/) \n\n# Feedback and Support\n\nTo report an issue or give feedback on GBDX Notebooks, click the \"feedback\" link on the right side of the window and fill out the feedback form.","excerpt":"Data Scientists have widely adopted tools such as the Jupyter Notebook to help them with their analysis and methods. We have adopted the Jupyter Notebooks to try to move our platform to where the users are already comfortable. We are super-charging Notebooks by building small, powerful, modular components to increase the productivity of the data science community.","slug":"gbdx-notebooks-course","type":"basic","title":"GBDX Notebooks Course"}

GBDX Notebooks Course

Data Scientists have widely adopted tools such as the Jupyter Notebook to help them with their analysis and methods. We have adopted the Jupyter Notebooks to try to move our platform to where the users are already comfortable. We are super-charging Notebooks by building small, powerful, modular components to increase the productivity of the data science community.

# Contents [block:parameters] { "data": { "h-0": "Table of Contents", "0-0": "[Getting Started](#section-getting-started)\n[Navigating GBDX Notebooks](#section-navigating-gbdx-notebooks)\n[My Library](#section-my-library)\n[Discover](#section-discover)\n[Create New Notebook](#section--create-new-notebook)\n[Documentation](#section-documentation)\n[Notebook Details Page](#section-notebook-details-page)\n[Creating a New Notebook](#section-creating-a-new-notebook)\n[GBDX Notebook Tutorials](#section-gbdx-notebook-tutorials)\n[Deploying Tasks](#section-deploying-tasks)\n[Running Tasks](#section-running-tasks)\n[Publishing a Notebook](#section-publishing-a-notebook)\n[Privacy and Sharing](#section-privacy-and-sharing)\n[Feedback and Support](#section-feedback-and-support)" }, "cols": 1, "rows": 1 } [/block] # Getting Started ##Prerequisites To sign in to GBDX Notebooks, these are required: Account | Description --- | --- A GBDX User Account | If you're already a GBDX user, you'll log into GBDX Notebooks with the same account credentials. If you're new to GBDX, you can create an account from within GBDX Notebooks. A Github Account | We link to your GitHub account so you can publish Gists and share notebooks with groups and organizations that may already exist in your GitHub accounts. You'll only need to link your accounts on your first login. ## Sign in to GBDX Notebooks To sign in or create a new GBDX account, go to https://notebooks.geobigdata.io . Click the "Log in or Sign Up" button at the top right of the screen. The sign in box will appear. [block:image] { "images": [ { "image": [ "https://files.readme.io/9380e68-Screen_Shot_2017-11-17_at_3.47.35_PM.png", "Screen Shot 2017-11-17 at 3.47.35 PM.png", 325, 396, "#ececeb" ], "caption": "Log in with your GBDX User Account credentials." } ] } [/block] Once you sign in to GBDX Notebooks, you'll be prompted to agree to the GBDX Terms of Use. enter your Github account credentials. ## Connect your Github Profile Next, you'll be prompted to connect your GitHub profile. If you don't have one, you can create one from this menu. [block:image] { "images": [ { "image": [ "https://files.readme.io/3673b93-GBDX_Notebooks_Connect_to_Github_profile.png", "GBDX Notebooks Connect to Github profile.png", 690, 260, "#dcd9d2" ], "caption": "Connect your GitHub profile to GBDX Notebooks, or create a GitHub profile if you don't have one." } ] } [/block] Once you click "connect", your GBDX and GitHub accounts will be connected. # Navigating GBDX Notebooks GBDX Notebooks is organized into four top level sections. Use the top navigation menu to visit each section. [block:image] { "images": [ { "image": [ "https://files.readme.io/b7ef218-Top_Navigation_Bar.png", "Top Navigation Bar.png", 780, 69, "#04365e" ], "caption": "GBDX Notebooks top navigation menu" } ] } [/block] Name | Description --- | --- My Library | Click "My Library" to see the library of Notebooks you've created. Discover | Explore published Notebooks, and clone and edit publicly available Notebooks you want to try out. +New Notebook | Create a new Notebook using the "New Notebook" tutorial, or start from a blank Notebook. Documentation | This link directs you back to the GBDX Notebooks user documentation. # My Library "My Library" displays the Notebooks you've created. From this page, edit, duplicate, or delete a Notebook. Filter your view by selecting one of the links to the right of the word "Notebooks". View | Description --- | --- All | Choose "All" to see your drafts and published Notebooks Drafts | Choose "Drafts" to see only your Notebooks that have not been published yet. Published | Choose "Published" to see only Notebooks that you have published. [block:image] { "images": [ { "image": [ "https://files.readme.io/e377a09-My_Library_22All22_view.png", "My Library %22All%22 view.png", 1065, 479, "#eaeaea" ], "caption": "\"My Library\" page, with the \"All\" view selected. This view shows all drafts and published Notebooks." } ] } [/block] ## Notebook Cover Information The "My Library" page displays a "cover" view of each of your Notebooks. Each cover provides basic information about the Notebook, and allows the user to take a series of actions. Information | Description --- | --- Name | The name given to the Notebook by the author Author | The Username of the Notebook's author Permissions | The permissions levels are "public" and "private". The default is "public". Date and Time | The date and time the Notebook was published. Cover Image | Displays the image provided by the Notebook's author. Tags | The tags provided by the Notebook's author. These tags are searchable from the "Discover" section. Tags only appear on the cover once the Notebook has been published. Description | The short description provided by the Notebook's author. Draft | If the Notebook has not been pulished, the cover will show "draft", and the description will be "Not published yet." ## Notebook Cover Actions From the Notebook cover, the following actions can be executed: Action | Description --- | --- Edit | Edit the content of an existing Notebook. Duplicate | Make a copy of a Notebook in your library. By default, the duplicated version will be given the same name, with a "-1" appended to it. The number will increase each time the Notebook is duplicated. See the example below. Delete | Delete the Notebook. This will delete the contents and cover. Details | Click "Details" to view the code and output of a Notebook. Metadata can be updated from the details page by clicking the pencil icon next to the name. Notebook content is not editable in this view. The "Details" button is only available for "published" Notebooks. ### "Duplicate" Naming Convention Example: Original: Simple_Change_Detection Duplicate 1: Simple_Change_Detection-1 Duplicate 2: SImple_Change_Detection-2 The name can be changed from within the Notebook. Click on the name at the top of the page, and the "Rename Notebook" box will pop up. # Discover The "Discover" page lets you browse tutorials, search and explore published Notebooks, and clone and edit a public Notebook. [block:image] { "images": [ { "image": [ "https://files.readme.io/c3dcf87-Explore_Notebooks_Screenshot.png", "Explore Notebooks Screenshot.png", 1017, 802, "#19577e" ], "caption": "From the Discover page, you can search for, clone, and edit public Notebooks, View Notebook tutorials, and see newly published Notebooks." } ] } [/block] ## Explore Notebooks The "Explore Notebooks" search feature lets you search for public Notebooks that meet your needs. When you type a word or phrase into the search box, our search engine looks for a full or partial match in the following fields: * Name * Author name * Tags * Description ## Notebook Tutorials The "Notebook Tutorials" section displays collections of tutorials. A collection is a group of tutorials that fall into the same category. Select the collection to view the Notebooks within it. [block:image] { "images": [ { "image": [ "https://files.readme.io/d0381a5-Notebook_tutorials.png", "Notebook tutorials.png", 1027, 197, "#165a86" ], "caption": "Notebook tutorials are organized into \"collections\"." } ] } [/block] These Notebooks tutorials will walk you through the basics on how to access imagery, and perform various operations against that imagery. The Notebooks are a great way for users to interact with the data with Python, and to learn about the structure and capabilities of DigitalGlobe imagery. For further documentation on "gbdxtools", a Python=based tools suite for interacting with GBDX, see [gbdxtools documentation] (http://gbdxtools.readthedocs.io/en/latest/). ## Newly Published Notebooks This section displays Notebooks that have been published recently. The newest Notebooks are displayed first. ## Search Results Once a search is executed, the set of Notebook covers that match the search criteria will be returned. Only publicly available Notebooks are returned. ## Notebook Covers ###Notebook Cover Information From this view, the Notebook cover shows the following details: Information | Description --- | --- Name | The name given to the Notebook by the author Author | The Username of the Notebook's author. Click on the author's name to see other Notebooks they've authored. Permissions | Only Notebooks with permissions set to "public" appear in this view. Date and Time | The date and time the Notebook was published. Cover Image | Displays the image provided by the Notebook's author. Tags | The #tags provided by the Notebook's author. These tags are searchable from the "Discover" section. Description | The short description provided by the Notebook's author. ### Notebook Cover Actions From this view, the following actions can be executed: Action | Description --- | --- Details | Select "Details" to view the code and output of a Notebook. Content is not editable in this view. Clone and Edit | Selecting the "Clone & Edit" button will create a copy of the Notebook in your own Jupyter Notebook environment. From there you can rename the Notebook, interact with the code, add new code, change the Area of Interest, and more. When you're ready, you can publish the Notebook. # Create New Notebook This page lets you create a new Notebook. There are two options available for Notebook creation: Option | Description | Notes --- | --- | --- Start with Imagery | This option opens an introductory tutorial with imagery and code samples. This option is ideal for first-time users. | Recommended Blank | This option opens a new Notebook with no code snippets or imagery. To use this option, you'll find imagery by using the AOI selection tool, and create your Python analysis from scratch. | Advanced # Documentation The Documentation link brings you back to the documentation you're reading now. You can easily access the GBDX Notebooks course from this link, or from the sidebar navigation on GBDX University. GBDX Notebooks tutorials are available from within the application. For example, to see the tutorial "Introduction to Image Access with GBDXTools", Choose "New Notebooks", and then "Start with Imagery". Other tutorials can be accessed from the "Discover" page. # Notebook Details Page View the Notebook details page by clicking the Notebook title or the "Details" button from the Notebook cover. ## View the Notebook Cover Information At the top of the Notebook details page, you can view the following: * Title * Publisher * Public or Private * Cover image * Published Date * Description * Searchable tags ## Clone and Edit The "Clone & Edit" button is available from the top of the Notebook Details Page. This button lets you clone a public Notebook, and then edit the contents of the copy. ## Interact with the Code Select "Code" to see the code used to create the Notebook in "read-only" mode. In this view, you'll see the main description, the section descriptions, the input code blocks, and the output of each section. ## View Outputs Select "Outputs" to see only the outputs of the Notebook. In this view, the code blocks are not displayed. # Creating a New Notebook To create a new Notebook, select "+New Notebook" from the top navigation bar. You can select one of the following ways to start your new Notebook: * Start with Imagery: This option opens an editable tutorial in your Juypter Notebooks environment. The tutorial walks you through selecting imagery and adding code to your Notebook. For first time users, we recommend this option. * Blank: This option opens a blank Notebook with no tutorials. You'll use the "imagery" tool on the left sidebar to select imagery. Once you start to create a new Notebook, you'll notice some differences between your GBDX Notebook and a standard Jupyter Notebook. While the default Notebook behavior is as standardized as possible, we've made changes to streamline your access to DigitalGlobe's imagery catalog. [block:image] { "images": [ { "image": [ "https://files.readme.io/b4de49b-Insert_record.png", "Insert record.png", 1174, 625, "#ededec" ] } ] } [/block] ## GBDX Notebooks Custom Toolbar The custom GBDX Notebooks toolbar will be displayed on the left side of the page. The toolbar offers the following options: [block:image] { "images": [ { "image": [ "https://files.readme.io/ef881b6-Screen_Shot_2018-01-05_at_10.58.36_AM.png", "Screen Shot 2018-01-05 at 10.58.36 AM.png", 60, 102, "#19a2da" ], "caption": "GBDX Notebooks custom toolbar" } ] } [/block] Tool or Link | Description --- | --- Imagery | The "imagery" icon opens the Area of Interest selection tool. Use this tool to search for imagery and create and save an Area of Interest. Deploy | Notebooks can be deployed as "tasks". The "Deploy" icon opens a form page where you'll input your task information and add your input and output requirements. From here, select "Publish" to deploy the task. ## Select an Area of Interest (AOI) Select the "Imagery" icon from the sidebar to open the AOI selection tool. GBDX Notebooks are designed to give access to small AOIs for users to build their methods and algorithms against. The AOI selection tool is zoom-level dependent. The red bar at the bottom of the map lets you know the AOI you've selected is too large. Keep zooming in until the bar turns green. Once the bar turns green, the text will say "Draw a rectangle to select an area of interest." ### Narrow your Search Area To start a search, we recommend typing a location in the search box. It can be a general area, such as "Denver" or a more specific area such as Denver International Airport, Denver, CO. Be as specific as possible to narrow your search. To zoom in or out to change your AOI, you can: [block:image] { "images": [ { "image": [] } ] } [/block] * Use the +(plus) button to zoom in, or the -(minus) button to zoom out. * Double click the left mouse button to zoom in. * Scroll your mouse wheel down to zoom in, and up to zoom out. [block:image] { "images": [ { "image": [ "https://files.readme.io/f8ac71d-AOI_Selection_-_Red_Bar.png", "AOI Selection - Red Bar.png", 531, 913, "#35421d" ], "caption": "In this example, the AOI is too large to allow imagery selection. The user will need to continue to zoom in to a smaller area. When the area is small enough, the zoom bar will turn green." } ] } [/block] ### Select an AOI Once you have zoomed in to a small enough area, draw a polygon around the specific area to create an AOI. There are two ways to draw a polygon: * Select the polygon icon, then click the starting location for your area. Draw and connect each side of your polygon. * Select the square icon. Click the start location for the square, then drag to create the boundaries. Once an area has been selected, the bounding box is shown in the green bar. [block:image] { "images": [ { "image": [ "https://files.readme.io/ca679b2-Screen_Shot_2017-11-17_at_12.52.40_PM.png", "Screen Shot 2017-11-17 at 12.52.40 PM.png", 1052, 1464, "#747264" ], "caption": "" } ] } [/block] Once you select an AOI, the search button at the bottom of the screen will be enabled. Select this button to execute a search. You can set search filters to narrow your results. ### Selecting Filters To set search filters before executing a search, click "Search Filters" in the lower left corner of the pane. When a search is executed, the search results pane is displayed. A horizontal scrolling selector is displayed for each filter. Once the filters are set, select the "search" button to execute the search. [block:image] { "images": [ { "image": [ "https://files.readme.io/2e9499a-Screen_Shot_2017-11-17_at_1.02.35_PM.png", "Screen Shot 2017-11-17 at 1.02.35 PM.png", 1046, 1032, "#747263" ], "caption": "Drag the control to the left or the right to change the filter values." } ] } [/block] ### AOI Search Results When a search is executed, the image count is displayed at the top of the screen, and the results display at the bottom of the pane. [block:image] { "images": [ { "image": [ "https://files.readme.io/c4ff962-Screen_Shot_2017-11-17_at_12.38.46_PM.png", "Screen Shot 2017-11-17 at 12.38.46 PM.png", 1032, 1600, "#7a775c" ], "caption": "There are 46 images in this results set." } ] } [/block] To narrow the results set further, choose "Additional Filters" in the top left corner of the pane. This brings up the filter box, and the filters can be changed using the horizontal scroll bar. #### Available Imagery *Data Sources*: GBDX Notebooks have access to WORLDVIEW-2 AND WORLDVIEW-3 products. GBDX Notebooks searches for products that are already available in the GBDX catalog. If an image is not available, it can be ordered through GBDX. Once an order is delivered to the GBDX catalog, the image will be available in GBDX Notebooks. See [Ordering Course v2](doc:ordering-course-v2) or [Ordering Imagery using gbdxtools](http://gbdxtools.readthedocs.io/en/latest/user_guide.html?highlight=order#ordering-imagery) for information on how to place an order. #### Search Results View The Search Results view displays the following for each record: Item | Description --- | --- Checkbox | Click to check the box next to a record. Clicking the box activates the "insert code" button in the lower right corner. Date | The date the image was acquired by the satellite. Coverage | Each record is part of the specific AOI you defined; not part of a full image strip. Coverage shows how much overlap exists between your AOI and the strip. 100% means that the image covers the entire AOI you selected. Source | The source is the satellite that acquired the image. Clouds | The percentage of cloud cover in the image. This will help you determine if the image will be useful or not. Preview | Preview lets you view the image before adding it to your Notebook. Insert | Selecting "Insert" adds the image request code to your Notebook, and fetches the image for preview. #### Preview an Image Selecting "Preview" displays the image and its metadata. If you need to find the catalog ID for an image, it's listed in this view. [block:image] { "images": [ { "image": [ "https://files.readme.io/af93230-Screen_Shot_2017-11-17_at_2.56.18_PM.png", "Screen Shot 2017-11-17 at 2.56.18 PM.png", 508, 530, "#595e4b" ], "caption": "The preview pane shows the select image and its associated metadata." } ] } [/block] #### Insert a Single Image Once you find an image you want to add to your Notebook for processing, click "insert" from the individual record in the search results, or in the preview pane. This will insert the cell for importing the image into the Notebook, and fetch the image. The cell gives key information about the image, and lets you begin analyzing the imagery. From this cell, you can find the catalog ID and bounding box. It has also plotted the multispectral band for the image. Many published and publicly available Notebooks have a cell like this as the first cell in the Notebook. You can insert your own cell into the Notebook. This will allow the Notebook to work on the AOI you've selected instead of the AOI included by the original author. [block:image] { "images": [ { "image": [ "https://files.readme.io/669abc5-Insert_Record2.png", "Insert Record2.png", 1199, 638, "#ededec" ], "caption": "This is the result of \"inserting\" an image from the AOI selector." } ] } [/block] #### Insert Code for Multiple Images To insert multiple images at once, click the check box next to each image you want to insert. This will activate the "Insert Code for [number] Images" button. [block:image] { "images": [ { "image": [ "https://files.readme.io/586cd7e-insert_code_for_multiple_images.png", "insert code for multiple images.png", 508, 356, "#0da3dd" ] } ] } [/block] When you insert code for multiple images at once, the result is a code snippet containing a JSON file. The JSON file contains pointers to all the images you selected. Using multiple images can be necessary when working with time series, working with change detection, creating mosaics, or anything else you can come up with. For more details on using the notebooks, and interacting with DigitalGlobe imagery you can access our Notebook tutorials, which will walk you through other common operations such as working with the various imagery bands, reprojecting the images, and viewing the full metadata. # GBDX Notebook Tutorials The GBDX Notebooks Tutorials are the best way to learn how to add capabilities to your Notebook with Python. This is an example of a GBDX Notebooks tutorial. https://notebooks.geobigdata.io/hub/notebooks/5a05ecba89e0d2084815bc5a Tutorial Notebooks can be cloned, and then edited for your own use. # Deploying Tasks Once you've created a Notebook that performs as you expect it to over a small AOI, you can scale your Notebook over much larger areas by deploying it as a GBDX task. This is a quick and easy way to deploy a task on the GBDX platform, without having to deploy it in a Docker container. This removes much of the overhead work of task deployment. To deploy a task, click the "Deploy" icon from the toolbar. This will open a new pane. In this pane, you'll add input variables, output variables, and task information. ## Inputs In the example below, this Notebook requires two catalog IDs, a "before" image and an "after" image, as well as a bounding box. These fields are populated into the ‘Deploy’ tab by looking for variables within the Python code you’ve written in your Notebook. You must have successfully executed a cell using that variable in order for it to show up as an option for the input. You can then use the drop downs under ‘Type’ to specify what type of variable this is. ## Outputs Outputs work in the same way. Variables that were specified within the Notebook will appear here. In this example we have a variable called ‘total_feaures’ which will output a string with the number of tents that were detected within the bounding box, as well as an output file, which will be output as a GeoJSON file. ## Task Metadata After you've specified your required inputs and outputs, you can give your task a name, description, and version number. Once you’ve deployed this task it will be available to run in your Notebook, or directly from "gbdxttools". [block:image] { "images": [ { "image": [ "https://files.readme.io/3eb122a-Deploy_Tasks_image.png", "Deploy Tasks image.png", 1600, 809, "#eeefef" ] } ] } [/block] ## Publish Once all the information has been populated, click the "publish" button to deploy your task. ## View your Deployed Tasks Once you have "published" or "deployed" a task, it will appear in the "Deployed Tasks" List. The task will first appear in "pending" state. This means it's in the process of being published. Once deployment is complete, a "run" button will appear next to the task. ### Example 1: Deployed Task in "Pending" State [block:image] { "images": [ { "image": [ "https://files.readme.io/0be0c9c-My_Tasks_1.png", "My Tasks 1.png", 1044, 333, "#405b5f" ], "caption": "Select \"Deployed Tasks to see a list of tasks published by you. The task in this example has just been deployed, and is still in the \"pending\" state." } ] } [/block] ### Example 2: Deployed Task in "Run" State [block:image] { "images": [ { "image": [ "https://files.readme.io/a649053-task_logs.png", "task logs.png", 1018, 540, "#50504a" ], "caption": "This example shows the same task once deployment is complete. The \"run\" button is now available, which allows you to run the task." } ] } [/block] ### Deployed Task States State | Description --- | --- Pending | The task deployment is running, but is not complete. Deployment can take up to 10 minutes. Run | Task deployment is complete. The task is now available to "run". ### Deployed Task List Details From the "Deployed Tasks" list, the following is displayed for each task: * Task Name * Version * Notebook Name * Description * "Move to Trash" icon # Running Tasks Once you click the "Run" button next to a task, you'll be able to run your task on GBDX at scale. To run a task from the "Deployed Tasks" list: 1. Select the "Run" button to the right of the task 2. Add the required inputs. These are the inputs you defined when deploying the task. 3. Click the "Run Task" button [block:image] { "images": [ { "image": [ "https://files.readme.io/d86aa1d-Run_Task.png", "Run Task.png", 1004, 874, "#287c98" ], "caption": "In this example, this task requires 2 catalog IDs and a bounding box. Input this information in the correct boxes, and then select \"Run Task\"." } ] } [/block] ## Task Run History Selecting "Run Task" adds your task to the GBDX queue. When a task is submitted to the queue, a "Task Run History" line item is displayed for the task. The "Task Run History" shows: * Date and Time submitted * A "Logs" button * An "Output" button (this button is grayed out until the task is complete). [block:image] { "images": [ { "image": [ "https://files.readme.io/dc97695-my_tasks_3.png", "my tasks 3.png", 1010, 436, "#d3dee0" ], "caption": "This example shows the \"Task Run History\" for the deployed task." } ] } [/block] ### Task Logs The "logs" section lets you check the status of your task,. From this view, you can see the tasks' events and states, along with any errors encountered during the task run. [block:image] { "images": [ { "image": [ "https://files.readme.io/73da2a3-task_logs.png", "task logs.png", 1018, 540, "#50504a" ] } ] } [/block] ### View Task Output Once the task has finished running, the "Output" button will become active. Selecting this button will show you the outputs you specified when deploying the task. [block:image] { "images": [ { "image": [ "https://files.readme.io/9ac5dca-Task_Output.png", "Task Output.png", 1600, 797, "#eae5e2" ], "caption": "This example shows the output of the Tent Counting algorith. The outputs are a feature count of 6,837 tents and a viewable GeoJSON file. You can now continue working with the GeoJSON in the Notebook, or view the results on a slippy map." } ] } [/block] Using the ‘Deployed Tasks" tab is the fastest and easiest way to scale up an arbitrary analysis you’ve created in your Notebook. Once you’ve created the task, it's simple to run it on other areas. You can run the same task with new Catalog IDs and a new bounding box. You can also specify multiple Catalog IDs to deploy your tasks at massive scales. # Publishing a Notebook Publishing your Notebook allows you to share it with the community or with other users privately. Once a Notebook is published, it appears in the list on the "Discover" page. Once your Notebook is ready to be shared, click the "Publish Notebook" button. [block:image] { "images": [ { "image": [ "https://files.readme.io/d78533e-publishing_Notebooks.png", "publishing Notebooks.png", 1600, 674, "#0a4771" ], "caption": "Click \"Publish Notebook\" to make your Notebook available for sharing." } ] } [/block] # Privacy and Sharing ## Private and Public Notebooks When a Notebook is published, it can be set to "private" or "public". "Public" Notebooks are viewable to all users from the "Discover" page. "Private" Notebooks can be set to be available only to you, or to a GitHub organization or group. ## Change Permissions Settings on a Notebook Permissions can only be set on Notebooks that have been published. The default permissions setting is "Public". To change the permissions settings for a Notebook, do the following: 1. From "My "Library", find the Notebook you want to update 2. Click the "Details" button on the Notebook cover (if the task has not been published yet, the "details" button will not appear). 3. From the "details" page, click the pencil icon next to the name. This will bring up a dialog box. [block:image] { "images": [ { "image": [ "https://files.readme.io/c6a533c-Screen_Shot_2017-11-21_at_11.15.27_AM.png", "Screen Shot 2017-11-21 at 11.15.27 AM.png", 1094, 209, "#f3f3f3" ], "caption": "Click the pencil icon next to the name to update Notebook metadata and change the privacy settings." } ] } [/block] 4. From this dialog box, you can update the Notebook's metadata, "unpublish" the Notebook, or change Permissions. Select "Permissions" to change the setting. [block:image] { "images": [ { "image": [ "https://files.readme.io/a1c1756-Screen_Shot_2017-11-21_at_11.16.38_AM.png", "Screen Shot 2017-11-21 at 11.16.38 AM.png", 1041, 328, "#f1f1f1" ], "caption": "Select \"Permissions\" to change the setting from public to private, and to share the Notebook with a group or organization." } ] } [/block] 5. From the "Global Permissions" page, select "Public" or "Private". If you select "Private", additional "Private" settings will be enabled. 6. To keep the Notebook private to you only, no other selections need to be made. 7. To keep the Notebook private, but share with your GitHub organization or group, choose the edit buttons and make a selection from the available options. [block:image] { "images": [ { "image": [ "https://files.readme.io/aa153d5-Screen_Shot_2017-11-21_at_11.17.47_AM.png", "Screen Shot 2017-11-21 at 11.17.47 AM.png", 1366, 420, "#376c91" ] } ] } [/block] 8. Once you've added or updated the metadata and privacy settings, select "publish" in the bottom right corner. [block:image] { "images": [ { "image": [ "https://files.readme.io/fe5e811-share_your_notebook.png", "share your notebook.png", 1600, 675, "#f1f1f1" ], "caption": "Click \"publish\" to publish the metadata that accompanies your Notebook." } ] } [/block] ## Cancel Publishing You can cancel publishing by clicking the "Cancel Publishing" button on page shown above. This button only appears when the Notebook has already been published. ## Publish Notebook as a gist Our hosted Notebooks have integrated access to publishing your Notebook as a [gist](https://help.github.com/articles/about-gists/). Click on the small arrow next to the ‘CellToolbar’ to automatically publish the Notebook you’re currently working in as a Gist, which can be accessed through your GitHub account. [block:image] { "images": [ { "image": [ "https://files.readme.io/1fb3ff8-Notebook_as_a_Gist.png", "Notebook as a Gist.png", 1600, 286, "#eff0ef" ] } ] } [/block] ##Jupyter Notebooks To learn more about Jupyter Notebooks, see [Jupyter Documentation](https://jupyter.readthedocs.io/en/latest/) # Feedback and Support To report an issue or give feedback on GBDX Notebooks, click the "feedback" link on the right side of the window and fill out the feedback form.