Skip to content

Commit 2b9c9a0

Browse files
AtmaManirohitgeo
authored andcommitted
V101 bad links (#81)
* Fix wrong location in comment * Merge dev branch into master for 0.2 Beta and Holistic Testing (#24) * Updated publishing samples to reflect changes made to source code * Updated Publihing SDs, shp, csv samples to reflect latest API changes * Publisher sample updates - added samples for web maps and web scene (#3) * Updated notebook title to match filename * Added a new sample to showcase publishing web maps and web scenes * Fixed credentials * Updated sample titled "Using and updating GIS content" (#4) * Updated notebook title to match filename * Added a new sample to showcase publishing web maps and web scenes * Fixed credentials * Updated the sample with additional examples * Fixed credentials * Added an example for line featuers. Added some text explaining what smart mapping is * Additional widgets to minimize scrolling. Fixed geocoder usage following API update * Updated geocoder usage to match API updates * Updated the sample to match gp service update. Added a bit more text explaining the usage of gp tools (#12) * Minor - updated sample to search for desired item to add instead of a fixed index (#13) * GIS analysts - sample illustrating spatial analysis using ArcGIS Python API (#14) * Initial commit * Furnished the sample with spatial analysis examples * Fixes for API changes. Added summary text and elaborated a few steps (#15) * new sample to showcase big data anlaysis using NYC taxi example (#16) * Updated hurricane tracks sample to match API changes (#17) * Updated hurricane tracks sample to match API changes and added descriptive text * updated credentials * Updated sample to match API changes, added explanatory text (#19) * clean up sample (#18) * clean up sample (#20) * Remove usage statistics notebook as the API isnt available This requires work on the portal backend as well as it does not yet support ASM. * bug fixes and added descriptive text (#22) * synced raster product sample in 05 Content Publishers folder to match that in 04 GIS Analysts and Data Scientists (#21) Thanks, @AtmaMani * Updated Overview page - updated sample TOC (#23) * doc updates * apidoc update for 0.2 beta release * updated install instructions * Updated samples download link to point to v0.2-beta release (#25) * fixed wrong import * fixed execution count * Use ReadTheDocs theme * apache 2.0 license specified * api doc updates * gis doc update * clean up doc * bug fixes in clone portal sample * V101 updates (#75) * v101 added a topic on masking passwords to the 'working with auth schemes' page * guide v101 added section showing how to use well-known raster functions * guide v101 - item2item relationships - added link to REST api showing a table of all possible relationship types * bug fixes for NYC taxi sample notebook * added install instructions from pro 1.4 * guide - getting started - name changes * guide - API overview - updated release notes for v1.0.1, naming changes * guide - 03 - naming changes * guide - 04 - naming changes * guide - 07 - naming changes * guide - landing page - naming changes * samples - naming changes * samples - added credentials * samples - switched to forward slash. Removed redundant thumbnail images * apidoc update * V101 publish packages & clone samples (#77) * content and notebook demonstrating publishing of packages as web layers * added sample showing how to publish packages as web layers * updated clone portals sample * minor doc update - gis.map (#79) * content and notebook demonstrating publishing of packages as web layers * added sample showing how to publish packages as web layers * updated clone portals sample * fix for #76 * v101 fixed bad links * fixed more links to become relative links * updated install instructions
1 parent bb6699f commit 2b9c9a0

26 files changed

+134
-127
lines changed

guide/01 Getting Started/Install and set up.ipynb

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
"The ArcGIS API for Python is distributed via conda. [Conda](http://conda.pydata.org/docs/get-started.html) is a popular package and environment manager application that helps you install and update packages such as the ArcGIS Python API and their dependencies. You can install the API through two main workflows - install through anaconda or install using ArcGIS Pro. Both are outlined below.\n",
1010
"\n",
1111
"## Step: 1 Get Conda\n",
12-
"Install the latest version of [Anaconda for Python](https://www.continuum.io/downloads) (for Python 3.5), if you don't already have conda. The ArcGIS API for Python requires Python 3.\n",
13-
"If you have installed ArcGIS Pro 1.3 or later, you already have conda and you can skip to the next step.\n",
12+
"Install the latest version of [Anaconda for Python](https://www.continuum.io/downloads) (for Python 3x), if you don't already have conda. The ArcGIS API for Python requires Python 3.5 or higher.\n",
13+
"If you have installed ArcGIS Pro 1.4 or later, you already have conda.\n",
1414
"\n",
1515
"## Step: 2 Install `arcgis` package\n",
1616
"To download and install the API in your conda environment, type the following command in your terminal.\n",
1717
"\n",
1818
" conda install -c esri arcgis\n",
1919
"\n",
20-
"If you are running a Windows OS, you can type this into your command prompt or PowerShell. If you are running a Mac or Linux OS, you can type this into your terminal application. In the screen shot below, I am typing this command into the Windows command prompt.\n",
20+
"If you are running a Windows OS, you can type this into your command prompt or PowerShell. If you are running a Mac or Linux OS, you can type this into your terminal application. The screen shot below shows this command being typed into the Windows command prompt.\n",
2121
"\n",
2222
"![install arcgis package](http://esri.github.io/arcgis-python-api/notebooks/nbimages/guide_getstarted_InstallAndSetup_01.PNG)\n",
2323
"\n",
@@ -26,25 +26,34 @@
2626
"\n",
2727
"![install using ArcGIS Pro](http://esri.github.io/arcgis-python-api/notebooks/nbimages/guide_getstarted_InstallAndSetup_03.PNG)\n",
2828
"\n",
29-
"If you have installed ArcGIS Pro 1.3, then you can use the **Python Command Prompt** shortcut within the ArcGIS Pro program group in Windows start menu and type the conda install command explained earlier. Depending on how you installed Pro, you might have to start this prompt with elevated privileges. \n",
29+
"Alternately, if you would like to install through the command line, you can use the **Python Command Prompt** shortcut within the ArcGIS Pro program group in Windows start menu and type the conda install command explained earlier. Depending on how you installed Pro, you might have to start this prompt with elevated privileges.\n",
3030
"\n",
3131
"You can now start using the API in your Python IDE of choice, or from the Jupyter Notebook environment.\n",
3232
"\n",
33+
"**Note**: \n",
34+
" * ArcGIS API for Python requires Pro 1.4 or later. If you are using Pro 1.3, please upgrade to 1.4 or later. If you cannot upgrade, you can still install the API by creating a new environment in conda with Python 3.5 or higher and install the API in that environment. However, if you follow this approach, you cannot use ArcPy and the API from the same Python environment. Instructions for this approach is below, type them one at a time in the Python Command Prompt:\n",
35+
" \n",
36+
" conda create --name my_new_pro_env python=3.6\n",
37+
" activate my_new_pro_env\n",
38+
" conda install -c esri arcgis\n",
39+
" \n",
40+
" * You can have both anaconda and ArcGIS Pro installed on the same computer and have the API installed in both. Thus if you have Pro 1.3, you can either install the API by creating a new environment (explained above) or by installing anaconda.\n",
41+
"\n",
3342
"### Upgrade from older arcgis package\n",
34-
"If you are upgrading from an older version of arcgis package, run the following command in your terminal:\n",
43+
"If you are upgrading from an older version of the arcgis package, run the following command in your terminal:\n",
3544
"\n",
3645
" conda upgrade -c esri arcgis\n",
3746
"\n",
38-
"If you are using ArcGIS Pro 1.4 or later to install the API, then as you guessed, you can use the **Update Packages** tab in the screen shot above to update.\n",
47+
"If you are using ArcGIS Pro 1.4 or later to install the API, you can use the **Update Packages** tab in the screen shot above to update. An alternate way to upgrade is to use the **Python Command Prompt** and type the above command.\n",
3948
"\n",
4049
"----------------------------\n",
4150
"### Offline install\n",
4251
"If you would like to install the API on a machine without internet or, if your workstation is in a disconnected network, you can do so in three steps. \n",
43-
" * First, install the latest version of [Anaconda for Python](https://www.continuum.io/downloads) (for Python 3.5). It is preferable you install full anaconda and not miniconda. \n",
44-
" * Next download the latest version of the API from [Esri's channel on anaconda.org](https://anaconda.org/Esri/arcgis/files) for your OS. For instance, if you are installing on Linux 64-bit, then download the package titled `linux-64/arcgis-1.0.1-py35_1.tar.bz2` into a known location.\n",
52+
" * First, install the latest version of [Anaconda for Python](https://www.continuum.io/downloads) (for Python 3x). It is preferable you install full anaconda and not miniconda. \n",
53+
" * Next download the latest version of the API from [Esri's channel on anaconda.org](https://anaconda.org/Esri/arcgis/files) for your OS. For instance, if you are installing on Linux 64-bit, then download the package titled `linux-64/arcgis-1.0.1-py36_1.tar.bz2` into a known location.\n",
4554
" * Run conda from your terminal and install the API using the following command\n",
4655
"\n",
47-
" `conda install /path_to_package_download_folder/linux-64/arcgis-1.0.1-py35_1.tar.bz2`\n",
56+
" `conda install /path_to_package_download_folder/linux-64/arcgis-1.0.1-py36_1.tar.bz2`\n",
4857
"\n",
4958
"If you find yourself installing the API in multiple machines or, if you need to use miniconda in your workflow, it might be beneficial to set up an offline conda channel. Refer to the [Esri Knowledge Base article for instructions](http://support.esri.com/Products/Developers/scripting-and-automation/arcgis-python-api/1-0#knowledge-base).\n",
5059
"\n",
@@ -63,9 +72,11 @@
6372
" my_gis = GIS()\n",
6473
" my_gis.map()\n",
6574
" \n",
66-
"If the installation went through fine, you should see a map come up as shown below:\n",
75+
"You should see a map come up as shown below:\n",
76+
"\n",
77+
"![test your install](http://esri.github.io/arcgis-python-api/notebooks/nbimages/guide_getstarted_InstallAndSetup_02.PNG)\n",
6778
"\n",
68-
"![test your install](http://esri.github.io/arcgis-python-api/notebooks/nbimages/guide_getstarted_InstallAndSetup_02.PNG)"
79+
"Next, you can learn more about the API using the [guide](/python/guide/) and try out the [samples](/python/sample-notebooks/)."
6980
]
7081
}
7182
],
@@ -85,7 +96,7 @@
8596
"name": "python",
8697
"nbconvert_exporter": "python",
8798
"pygments_lexer": "ipython3",
88-
"version": "3.6.0"
99+
"version": "3.5.2"
89100
}
90101
},
91102
"nbformat": 4,

guide/08 Finding places with Geocoding/Batch Geocoding.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@
313313
"<a id=\"category-parameter\"></a>\n",
314314
"### category parameter\n",
315315
"\n",
316-
"A place or address type which can be used to filter batch geocoding results. The parameter supports input of single category values or multiple comma-separated values. See the help topic <a href=\"https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm\">Category filtering</a> for complete details about the category parameter.\n",
316+
"A place or address type which can be used to filter batch geocoding results. The parameter supports input of single category values or multiple comma-separated values. See the help topic <a href=\"/rest/geocode/api-reference/geocoding-category-filtering.htm\">Category filtering</a> for complete details about the category parameter.\n",
317317
"\n",
318318
"Example of category filtering with a single category:\n",
319319
"\n",
@@ -335,7 +335,7 @@
335335
"\n",
336336
"Acceptable values include the full country name, the ISO 3166-1 2-digit country code, or the ISO 3166-1 3-digit country code.\n",
337337
"\n",
338-
"A list of supported countries and codes is available <a href=\"https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm\">here</a>.\n",
338+
"A list of supported countries and codes is available <a href=\"/rest/geocode/api-reference/geocode-coverage.htm\">here</a>.\n",
339339
"\n",
340340
"Example:\n",
341341
"\n",
@@ -357,7 +357,7 @@
357357
"<a id=\"batch-geocoding-output-fields\"></a>\n",
358358
"### Batch geocoding output fields\n",
359359
"\n",
360-
"When you geocode a list of addresses, the output fields are returned as part of the attributes in the response. See the example JSON response below which shows all of the output fields that are returned for each record from a batch geocode process. The output fields are described <a href=\"https://developers.arcgis.com/rest/geocode/api-reference/geocoding-service-output.htm#ESRI_SECTION1_42D7D3D0231241E9B656C01438209440\">here</a>.\n",
360+
"When you geocode a list of addresses, the output fields are returned as part of the attributes in the response. See the example JSON response below which shows all of the output fields that are returned for each record from a batch geocode process. The output fields are described <a href=\"/rest/geocode/api-reference/geocoding-service-output.htm#ESRI_SECTION1_42D7D3D0231241E9B656C01438209440\">here</a>.\n",
361361
"\n",
362362
"<a id=\"examples\"></a>\n",
363363
"## Batch geocoding examples\n",
@@ -593,7 +593,7 @@
593593
"name": "python",
594594
"nbconvert_exporter": "python",
595595
"pygments_lexer": "ipython3",
596-
"version": "3.5.2"
596+
"version": "3.6.0"
597597
}
598598
},
599599
"nbformat": 4,

guide/08 Finding places with Geocoding/Filtering your geocoding results.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -657,7 +657,7 @@
657657
"cell_type": "markdown",
658658
"metadata": {},
659659
"source": [
660-
"See the topic <a href=\"https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm\">Category filtering</a> for complete details."
660+
"See the topic <a href=\"/rest/geocode/api-reference/geocoding-category-filtering.htm\">Category filtering</a> for complete details."
661661
]
662662
}
663663
],
@@ -677,7 +677,7 @@
677677
"name": "python",
678678
"nbconvert_exporter": "python",
679679
"pygments_lexer": "ipython3",
680-
"version": "3.5.2"
680+
"version": "3.6.0"
681681
}
682682
},
683683
"nbformat": 4,

guide/08 Finding places with Geocoding/Reverse Geocoding.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@
286286
"\n",
287287
"Sets the language in which reverse-geocoded addresses are returned. Addresses in many countries are available in more than one language; in these cases the langCode parameter can be used to specify which language should be used for addresses returned by the reverse_geocode() method. This is useful for ensuring that addresses are returned in the expected language by reverse geocoding functionality in an application. For example, a web application could be designed to get the browser language and then pass it as the langCode parameter value in a reverseGeocode request.\n",
288288
"\n",
289-
"See the <a href=\"https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm#GUID-D61FB53E-32DF-4E0E-A1CC-473BA38A23C0\">table of supported countries</a> for valid language code values in each country. The Two-Digit Language Codes column provides the valid input values for the langCode parameter. Only the two-digit language codes in this column are accepted as valid input; neither three-digit language codes nor full language names can be used with the langCode parameter.\n",
289+
"See the <a href=\"/rest/geocode/api-reference/geocode-coverage.htm#GUID-D61FB53E-32DF-4E0E-A1CC-473BA38A23C0\">table of supported countries</a> for valid language code values in each country. The Two-Digit Language Codes column provides the valid input values for the langCode parameter. Only the two-digit language codes in this column are accepted as valid input; neither three-digit language codes nor full language names can be used with the langCode parameter.\n",
290290
"\n",
291291
"Note:\n",
292292
"The language code \"XX\" is a convention used to represent transliterated or transcribed versions of a language.\n",
@@ -451,7 +451,7 @@
451451
"name": "python",
452452
"nbconvert_exporter": "python",
453453
"pygments_lexer": "ipython3",
454-
"version": "3.5.2"
454+
"version": "3.6.0"
455455
}
456456
},
457457
"nbformat": 4,

guide/08 Finding places with Geocoding/Understanding geocoders.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"\n",
3535
"A GIS includes one or more geocoders. The list of geocoders registered with the GIS can be queried using `get_geocoders()`. This method returns a list of `Geocoder` instances.\n",
3636
"\n",
37-
"In the example below, there is one registered Geocoder with the GIS, that uses the [Esri World Geocoding Service](https://developers.arcgis.com/features/geocoding/) for geocoding:"
37+
"In the example below, there is one registered Geocoder with the GIS, that uses the [Esri World Geocoding Service](/features/geocoding/) for geocoding:"
3838
]
3939
},
4040
{
@@ -463,7 +463,7 @@
463463
"metadata": {},
464464
"source": [
465465
"#### Localized input field names\n",
466-
"Developers integrating the geocoder into their application may need to know the appropriate input field names to use for the language and country of their users. This information can be obtained using the 'localizedNames' parameter of the address field. More information on this as well as the 'recognizedNames' parameter is avilable in the <a href=\"https://developers.arcgis.com/rest/geocode/api-reference/geocoding-localized-input-field-names.htm#ESRI_SECTION1_420C0A38D36546EDB1FC114048757B3E\">Foreign language field names (World Geocoding Service)</a> documentation\n",
466+
"Developers integrating the geocoder into their application may need to know the appropriate input field names to use for the language and country of their users. This information can be obtained using the 'localizedNames' parameter of the address field. More information on this as well as the 'recognizedNames' parameter is avilable in the <a href=\"/rest/geocode/api-reference/geocoding-localized-input-field-names.htm#ESRI_SECTION1_420C0A38D36546EDB1FC114048757B3E\">Foreign language field names (World Geocoding Service)</a> documentation\n",
467467
"\n",
468468
"For example, the code below lists the supported address fields and the corresponding input field names in Hindi:"
469469
]
@@ -503,7 +503,7 @@
503503
"<a id=\"categories-property\"></a>\n",
504504
"### `Categories` property\n",
505505
"\t\n",
506-
"The 'categories' property can be used to limit result to one or more categories. For example, \"Populated Place\" or \"Scandinavian Food\". Only applies to the World Geocode Service. See <a href=\"https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm#ESRI_SECTION1_502B3FE2028145D7B189C25B1A00E17B\">Category filtering (World Geocoding Service)</a> for more information.\n",
506+
"The 'categories' property can be used to limit result to one or more categories. For example, \"Populated Place\" or \"Scandinavian Food\". Only applies to the World Geocode Service. See <a href=\"/rest/geocode/api-reference/geocoding-category-filtering.htm#ESRI_SECTION1_502B3FE2028145D7B189C25B1A00E17B\">Category filtering (World Geocoding Service)</a> for more information.\n",
507507
"\n",
508508
"The following code lists the entire hierarchy of supported category values."
509509
]
@@ -1051,7 +1051,7 @@
10511051
"name": "python",
10521052
"nbconvert_exporter": "python",
10531053
"pygments_lexer": "ipython3",
1054-
"version": "3.5.2"
1054+
"version": "3.6.0"
10551055
}
10561056
},
10571057
"nbformat": 4,

guide/08 Finding places with Geocoding/Understanding the geocode function.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,7 @@
608608
"<a id=\"out-fields-parameter\"></a>\n",
609609
"### out_fields parameter\n",
610610
"\n",
611-
"The list of fields to be returned in the response. Descriptions for each of these fields are available in the <a href=\"https://developers.arcgis.com/rest/geocode/api-reference/geocoding-service-output.htm#ESRI_SECTION1_42D7D3D0231241E9B656C01438209440\">Output fields section of this document</a>.\n",
611+
"The list of fields to be returned in the response. Descriptions for each of these fields are available in the <a href=\"/rest/geocode/api-reference/geocoding-service-output.htm#ESRI_SECTION1_42D7D3D0231241E9B656C01438209440\">Output fields section of this document</a>.\n",
612612
"\n",
613613
"The returned address, x/y coordinates of the match location, match score, spatial reference, extent of the output feature, and the addr_type (match level) are returned by default.\n",
614614
"\n",
@@ -640,7 +640,7 @@
640640
"\n",
641641
"ArcGIS Online service credits are deducted from the organization account for each geocode transaction that includes the forStorage parameter with a value of true. Refer to the <a href=\"http://www.esri.com/SOFTWARE/ARCGIS/ARCGISONLINE/CREDITS\">ArcGIS Online service credits overview page</a> for more information on how credits are charged.\n",
642642
"\n",
643-
"To learn more about free and paid geocoding operations, see <a href=\"https://developers.arcgis.com/rest/geocode/api-reference/geocoding-free-vs-paid.htm\">this help topic</a>.\n",
643+
"To learn more about free and paid geocoding operations, see <a href=\"/rest/geocode/api-reference/geocoding-free-vs-paid.htm\">this help topic</a>.\n",
644644
"\n",
645645
"Example:\n",
646646
"\n",
@@ -664,7 +664,7 @@
664664
"name": "python",
665665
"nbconvert_exporter": "python",
666666
"pygments_lexer": "ipython3",
667-
"version": "3.5.2"
667+
"version": "3.6.0"
668668
}
669669
},
670670
"nbformat": 4,

0 commit comments

Comments
 (0)