Skip to content
This repository was archived by the owner on Jan 5, 2023. It is now read-only.

Commit 998402c

Browse files
authored
Update README.md
1 parent a34d978 commit 998402c

File tree

1 file changed

+10
-59
lines changed

1 file changed

+10
-59
lines changed

README.md

Lines changed: 10 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -13,53 +13,45 @@ When the reader has completed this Code Pattern, they will understand how to:
1313

1414
The intended audience for this Code Pattern is application developers and other stakeholders who wish to utilize the power of Data Science quickly and effectively.
1515

16-
![architecture](doc/source/images/architecture.png)
16+
## Flow
1717

18-
# Flow
18+
![architecture](doc/source/images/architecture.png)
1919

2020
1. Load the Jupyter notebook onto the IBM Watson Studio platform.
2121
1. USGS data from the Houston flood of 2017 is loaded into the notebook.
2222
1. The notebook is used to clean the data, and then display it.
2323
1. A PixieApp dashboard is created and can be interacted with.
2424
1. Mapbox and Folium are used for map visualizations
2525

26-
# Included Components
26+
## Included technologies
2727

2828
* [IBM Watson Studio](https://www.ibm.com/cloud/watson-studio): Analyze data using RStudio, Jupyter, and Python in a configured, collaborative environment that includes IBM value-adds, such as managed Spark.
29-
30-
## Featured technologies
31-
3229
* [Jupyter Notebooks](https://jupyter.org/): An open-source web application that allows you to create and share documents that contain live code, equations, visualizations and explanatory text.
33-
3430
* [PixieDust](https://github.com/pixiedust/pixiedust) Python helper library for python notebooks
35-
3631
* [PixieApps](https://pixiedust.github.io/pixiedust/pixieapps.html): Python library used to write UI elements for analytics, and run them directly in a Jupyter notebook.
37-
3832
* [Mapbox GL](https://www.mapbox.com/mapbox-gl-js/api/): JavaScript library that uses WebGL to render interactive maps.
3933

40-
# Prerequisites
34+
## Prerequisites
4135

4236
* An account on IBM Cloud to access [Watson Studio](https://www.ibm.com/cloud/watson-studio)
4337
* Get a [Mapbox Token](https://www.mapbox.com/) for use in the notebook
4438

45-
# Steps
39+
## Steps
4640

4741
Follow these steps to setup and run this Code Pattern. The steps are
4842
described in detail below.
4943

5044
1. [Sign up for the Watson Studio](#1-sign-up-for-watson-studio)
5145
2. [Create the notebook](#2-create-the-notebook)
5246
3. [Run the notebook](#3-run-the-notebook)
53-
4. [Analyze the results](#4-analyze-the-results)
54-
5. [Save and Share](#5-save-and-share)
5547

56-
## 1. Sign up for Watson Studio
48+
### 1. Sign up for Watson Studio
5749

5850
Sign up for IBM's [Watson Studio](https://dataplatform.cloud.ibm.com/). By creating a project in Watson Studio a free tier ``Object Storage`` service will be created in your IBM Cloud account. Take note of your service names as you will need to select them in the following steps.
5951

6052
> Note: When creating your Object Storage service, select the ``Free`` storage type in order to avoid having to pay an upgrade fee.
6153
62-
## 3. Create the notebook
54+
### 2. Create the notebook
6355

6456
* In [Watson Studio](https://dataplatform.cloud.ibm.com/), click `New Project +` under Projects or, at the top of the page click `+ New` and choose the tile for `Data Science` and then `Create Project`.
6557
* In [Watson Studio](https://dataplatform.cloud.ibm.com/) using the project you've created, click on `+ Add to project` and then choose the `Notebook` tile, OR in the `Assets` tab under `Notebooks` choose `+ New notebook` to create a notebook.
@@ -72,7 +64,7 @@ Sign up for IBM's [Watson Studio](https://dataplatform.cloud.ibm.com/). By creat
7264

7365
![Create Notebook](doc/source/images/DataVisualizationCreateNotebook.png)
7466

75-
## 4. Run the notebook
67+
### 3. Run the notebook
7668

7769
> NOTE: See the points in the notebook where you will have to enter your [Mapbox Token](https://www.mapbox.com) to render the map.
7870
@@ -100,52 +92,11 @@ There are several ways to execute the code cells in your notebook:
10092
panel. Here you can schedule your notebook to be executed once at some future
10193
time, or repeatedly at your specified interval.
10294

103-
## 5. Analyze the Results
104-
105-
## 6. Save and Share
106-
107-
108-
### How to save your work:
109-
110-
Under the `File` menu, there are several ways to save your notebook:
111-
112-
* `Save` will simply save the current state of your notebook, without any version
113-
information.
114-
* `Save Version` will save your current state of your notebook with a version tag
115-
that contains a date and time stamp. Up to 10 versions of your notebook can be
116-
saved, each one retrievable by selecting the `Revert To Version` menu item.
117-
118-
### How to share your work:
119-
120-
You can share your notebook by selecting the “Share” button located in the top
121-
right section of your notebook panel. The end result of this action will be a URL
122-
link that will display a “read-only” version of your notebook. You have several
123-
options to specify exactly what you want shared from your notebook:
124-
125-
* `Only text and output`: will remove all code cells from the notebook view.
126-
* `All content excluding sensitive code cells`: will remove any code cells
127-
that contain a *sensitive* tag. For example, `# @hidden_cell` is used to protect
128-
your dashDB credentials from being shared.
129-
* `All content, including code`: displays the notebook as is.
130-
* A variety of `download as` options are also available in the menu.
131-
132-
# Sample Output
95+
## Sample Output
13396

13497
> Note: Some interactive map functionality, like ```Options``` and ```Layers``` will not work. To see these, you must run the notebook itself.
13598
136-
# Links
137-
* [PixieDust](https://github.com/pixiedust/pixiedust)
138-
* [PixieApps](https://pixiedust.github.io/pixiedust/pixieapps.html)
139-
140-
# Learn more
141-
142-
* **Artificial Intelligence Code Patterns**: Enjoyed this Code Pattern? Check out our other [AI Code Patterns](https://developer.ibm.com/technologies/artificial-intelligence/).
143-
* **Data Analytics Code Patterns**: Enjoyed this Code Pattern? Check out our other [Data Analytics Code Patterns](https://developer.ibm.com/technologies/data-science/)
144-
* **AI and Data Code Pattern Playlist**: Bookmark our [playlist](https://www.youtube.com/playlist?list=PLzUbsvIyrNfknNewObx5N7uGZ5FKH0Fde) with all of our Code Pattern videos
145-
* **With Watson**: Want to take your Watson app to the next level? Looking to utilize Watson Brand assets? [Join the With Watson program](https://www.ibm.com/watson/with-watson/) to leverage exclusive brand, marketing, and tech resources to amplify and accelerate your Watson embedded commercial solution.
146-
* **Watson Studio**: Master the art of data science with IBM's [Watson Studio](https://dataplatform.cloud.ibm.com/)
147-
148-
# License
99+
## License
149100

150101
This code pattern is licensed under the Apache Software License, Version 2. Separate third party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the [Developer Certificate of Origin, Version 1.1 (DCO)](https://developercertificate.org/) and the [Apache Software License, Version 2](https://www.apache.org/licenses/LICENSE-2.0.txt).
151102

0 commit comments

Comments
 (0)