Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ As stated in [Xarray Spatial code of conduct](https://github.com/makepath/xarray

### Getting Started

Information about installation and setting up a development environment can be found at the [Getting Started page] https://xarray-spatial.org/getting_started/index.html.
Information about installation and setting up a development environment can be found at the [Getting Started page] https://xarray-spatial.readthedocs.io/getting_started/index.html.

### Choosing something to work on

Expand Down
4 changes: 2 additions & 2 deletions docs/source/_templates/versions.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Versions') }}">
<div class="deprecated-warning">
The documentation on this page refers to a PREVIOUS VERSION. For the latest release, go to <a
href="https://xarray-spatial.org/">https://xarray-spatial.org/</a></div>
href="https://xarray-spatial.readthedocs.io/">https://xarray-spatial.readthedocs.io/</a></div>
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Versions</span>
<span class="fa fa-caret-down"></span>
Expand All @@ -15,4 +15,4 @@
</dl>
<dl>
</div>
</div>
</div>
20 changes: 10 additions & 10 deletions docs/source/user_guide/local.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"id": "867a9d39",
"metadata": {},
"source": [
"In this notebook, we'll demonstrate how to use the [Xarray-spatial](http://xarray-spatial.org/) local tools functions supported by [Numpy](https://numpy.org/). The spatial functions available are:\n",
"In this notebook, we'll demonstrate how to use the [Xarray-spatial](http://xarray-spatial.readthedocs.io/) local tools functions supported by [Numpy](https://numpy.org/). The spatial functions available are:\n",
"\n",
"- [Cell Statistics](#Cell-Statistics) \n",
"- [Combine](#Combine) \n",
Expand Down Expand Up @@ -146,7 +146,7 @@
"id": "01ab159c",
"metadata": {},
"source": [
"[xrspatial.local.cell_stats](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.cell_stats.html) calculates statistics from a raster dataset on a cell-by-cell basis."
"[xrspatial.local.cell_stats](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.cell_stats.html) calculates statistics from a raster dataset on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -210,7 +210,7 @@
"id": "87c34a83",
"metadata": {},
"source": [
"[xrspatial.local.combine](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.combine.html) combines multiple arrays from a raster dataset, assigning a unique output value to each unique combination of raster values."
"[xrspatial.local.combine](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.combine.html) combines multiple arrays from a raster dataset, assigning a unique output value to each unique combination of raster values."
]
},
{
Expand Down Expand Up @@ -258,7 +258,7 @@
"id": "4f6da50e",
"metadata": {},
"source": [
"[xrspatial.local.lesser_frequency](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.lesser_frequency.html) calculates, given a raster dataset, the number of times the data variables values are lower than the values of a given reference data variable on a cell-by-cell basis."
"[xrspatial.local.lesser_frequency](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.lesser_frequency.html) calculates, given a raster dataset, the number of times the data variables values are lower than the values of a given reference data variable on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -308,7 +308,7 @@
"id": "0a2d8118",
"metadata": {},
"source": [
"[xrspatial.local.equal_frequency](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.equal_frequency.html) calculates, given a raster dataset, the number of times the data variables values are equal than the values of a given reference data variable on a cell-by-cell basis."
"[xrspatial.local.equal_frequency](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.equal_frequency.html) calculates, given a raster dataset, the number of times the data variables values are equal than the values of a given reference data variable on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -358,7 +358,7 @@
"id": "43c18c06",
"metadata": {},
"source": [
"[xrspatial.local.greater_frequency](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.greater_frequency.html) calculates, given a raster dataset, the number of times the data variables values are greater than the values of a given reference data variable on a cell-by-cell basis."
"[xrspatial.local.greater_frequency](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.greater_frequency.html) calculates, given a raster dataset, the number of times the data variables values are greater than the values of a given reference data variable on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -408,7 +408,7 @@
"id": "8d7235ec",
"metadata": {},
"source": [
"[xrspatial.local.lowest_position](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.lowest_position.html) calculates the data variable index of the lowest value on a cell-by-cell basis."
"[xrspatial.local.lowest_position](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.lowest_position.html) calculates the data variable index of the lowest value on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -457,7 +457,7 @@
"id": "a17c6e93",
"metadata": {},
"source": [
"[xrspatial.local.highest_position](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.highest_position.html) calculates the data variable index of the highest value on a cell-by-cell basis."
"[xrspatial.local.highest_position](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.highest_position.html) calculates the data variable index of the highest value on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -506,7 +506,7 @@
"id": "e5408cea",
"metadata": {},
"source": [
"[xrspatial.local.popularity](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.popularity.html) calculates the number of occurrences of each value of a raster dataset, on a cell-by-cell basis. The output value is assigned based on the reference data variable nth most popular."
"[xrspatial.local.popularity](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.popularity.html) calculates the number of occurrences of each value of a raster dataset, on a cell-by-cell basis. The output value is assigned based on the reference data variable nth most popular."
]
},
{
Expand Down Expand Up @@ -557,7 +557,7 @@
"id": "385dac65",
"metadata": {},
"source": [
"[xrspatial.local.rank](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.rank.html) calculates the rank of each value of a raster dataset, on a cell-by-cell basis. The output value is assigned based on the rank of the reference data variable rank."
"[xrspatial.local.rank](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.rank.html) calculates the rank of each value of a raster dataset, on a cell-by-cell basis. The output value is assigned based on the rank of the reference data variable rank."
]
},
{
Expand Down
20 changes: 10 additions & 10 deletions examples/user_guide/8_Local_Tools.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"id": "ea55ffed",
"metadata": {},
"source": [
"In this notebook, we'll demonstrate how to use the [Xarray-spatial](http://xarray-spatial.org/) local tools functions supported by [Numpy](https://numpy.org/). The spatial functions available are:\n",
"In this notebook, we'll demonstrate how to use the [Xarray-spatial](http://xarray-spatial.readthedocs.io/) local tools functions supported by [Numpy](https://numpy.org/). The spatial functions available are:\n",
"- [Cell Statistics](#Cell-Statistics)\n",
"- [Combine](#Combine)\n",
"- [Lesser Frequency](#Lesser-Frequency)\n",
Expand Down Expand Up @@ -143,7 +143,7 @@
"id": "01ab159c",
"metadata": {},
"source": [
"[`xrspatial.local.cell_stats`](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.cell_stats.html) calculates statistics from a raster dataset on a cell-by-cell basis."
"[`xrspatial.local.cell_stats`](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.cell_stats.html) calculates statistics from a raster dataset on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -186,7 +186,7 @@
"id": "87c34a83",
"metadata": {},
"source": [
"[`xrspatial.local.combine`](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.combine.html) combines multiple arrays from a raster dataset, assigning a unique output value to each unique combination of raster values."
"[`xrspatial.local.combine`](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.combine.html) combines multiple arrays from a raster dataset, assigning a unique output value to each unique combination of raster values."
]
},
{
Expand Down Expand Up @@ -223,7 +223,7 @@
"id": "4f6da50e",
"metadata": {},
"source": [
"[`xrspatial.local.lesser_frequency`](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.lesser_frequency.html) calculates, given a raster dataset, the number of times the data variables values are lower than the values of a given reference data variable on a cell-by-cell basis."
"[`xrspatial.local.lesser_frequency`](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.lesser_frequency.html) calculates, given a raster dataset, the number of times the data variables values are lower than the values of a given reference data variable on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -262,7 +262,7 @@
"id": "intelligent-philadelphia",
"metadata": {},
"source": [
"[`xrspatial.local.equal_frequency`](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.equal_frequency.html) calculates, given a raster dataset, the number of times the data variables values are equal than the values of a given reference data variable on a cell-by-cell basis."
"[`xrspatial.local.equal_frequency`](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.equal_frequency.html) calculates, given a raster dataset, the number of times the data variables values are equal than the values of a given reference data variable on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -301,7 +301,7 @@
"id": "vocational-inside",
"metadata": {},
"source": [
"[`xrspatial.local.greater_frequency`](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.greater_frequency.html) calculates, given a raster dataset, the number of times the data variables values are greater than the values of a given reference data variable on a cell-by-cell basis."
"[`xrspatial.local.greater_frequency`](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.greater_frequency.html) calculates, given a raster dataset, the number of times the data variables values are greater than the values of a given reference data variable on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -340,7 +340,7 @@
"id": "8d7235ec",
"metadata": {},
"source": [
"[`xrspatial.local.lowest_position`](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.lowest_position.html) calculates the data variable index of the lowest value on a cell-by-cell basis."
"[`xrspatial.local.lowest_position`](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.lowest_position.html) calculates the data variable index of the lowest value on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -378,7 +378,7 @@
"id": "a17c6e93",
"metadata": {},
"source": [
"[`xrspatial.local.highest_position`](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.highest_position.html) calculates the data variable index of the highest value on a cell-by-cell basis."
"[`xrspatial.local.highest_position`](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.highest_position.html) calculates the data variable index of the highest value on a cell-by-cell basis."
]
},
{
Expand Down Expand Up @@ -416,7 +416,7 @@
"id": "e5408cea",
"metadata": {},
"source": [
"[`xrspatial.local.popularity`](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.popularity.html) calculates the number of occurrences of each value of a raster dataset, on a cell-by-cell basis. The output value is assigned based on the reference data variable nth most popular."
"[`xrspatial.local.popularity`](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.popularity.html) calculates the number of occurrences of each value of a raster dataset, on a cell-by-cell basis. The output value is assigned based on the reference data variable nth most popular."
]
},
{
Expand Down Expand Up @@ -456,7 +456,7 @@
"id": "385dac65",
"metadata": {},
"source": [
"[`xrspatial.local.rank`](https://xarray-spatial.org/reference/_autosummary/xrspatial.local.rank.html) calculates the rank of each value of a raster dataset, on a cell-by-cell basis. The output value is assigned based on the rank of the reference data variable rank."
"[`xrspatial.local.rank`](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.local.rank.html) calculates the rank of each value of a raster dataset, on a cell-by-cell basis. The output value is assigned based on the rank of the reference data variable rank."
]
},
{
Expand Down
12 changes: 6 additions & 6 deletions examples/xarray-spatial_classification-methods.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"\n",
"This tutorial walks you through:\n",
"1. Loading and rendering the area of interest data using the Grand Canyon's latitude and longitude.\n",
"2. Classifying the data using xarray-spatial's [natural breaks](https://xarray-spatial.org/reference/_autosummary/xrspatial.classify.natural_breaks.html), [equal interval](https://xarray-spatial.org/reference/_autosummary/xrspatial.classify.equal_interval.html), [quantile](https://xarray-spatial.org/reference/_autosummary/xrspatial.classify.quantile.html), and [reclassify](https://xarray-spatial.org/reference/_autosummary/xrspatial.classify.reclassify.html) functions.\n",
"2. Classifying the data using xarray-spatial's [natural breaks](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.classify.natural_breaks.html), [equal interval](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.classify.equal_interval.html), [quantile](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.classify.quantile.html), and [reclassify](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.classify.reclassify.html) functions.\n",
"\n",
"\n",
"This tutorial uses the [NASADEM](https://github.com/microsoft/AIforEarthDatasets#nasadem) dataset from the [Microsoft Planetary Computer Data Catalog](https://planetarycomputer.microsoft.com/catalog). The area of interest roughly covers the Grand Canyon National Park. The [NASADEM](https://github.com/microsoft/AIforEarthDatasets#nasadem) dataset provides global topographic data at 1 arc-second (~30m) horizontal resolution. The data is derived primarily from data captured via the [Shuttle Radar Topography Mission](https://www2.jpl.nasa.gov/srtm/) (SRTM) and is stored on Azure Storage in [cloud-optimized GeoTIFF](https://www.cogeo.org/) format.\n"
Expand Down Expand Up @@ -181,7 +181,7 @@
"id": "41759319",
"metadata": {},
"source": [
"Use the [natural breaks](https://xarray-spatial.org/reference/_autosummary/xrspatial.classify.natural_breaks.html) function to classify data with the [Jenks natural breaks classification](http://wiki.gis.com/wiki/index.php/Jenks_Natural_Breaks_Classification) method. This method is designed to distribute data into classes according to clusters that form a \"natural\" group within the data. The algorithm minimizes the average deviation from the class mean while also maximizing the deviation from the means of the other groups. Therefore, it is generally not recommended for data with low variance."
"Use the [natural breaks](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.classify.natural_breaks.html) function to classify data with the [Jenks natural breaks classification](http://wiki.gis.com/wiki/index.php/Jenks_Natural_Breaks_Classification) method. This method is designed to distribute data into classes according to clusters that form a \"natural\" group within the data. The algorithm minimizes the average deviation from the class mean while also maximizing the deviation from the means of the other groups. Therefore, it is generally not recommended for data with low variance."
]
},
{
Expand Down Expand Up @@ -221,7 +221,7 @@
"id": "baed3e1b",
"metadata": {},
"source": [
"To classify data into sets based on intervals of equal width, use the [equal interval](https://xarray-spatial.org/reference/_autosummary/xrspatial.classify.equal_interval.html) function. The [equal interval classification](http://wiki.gis.com/wiki/index.php/Equal_Interval_classification) is useful in cases where you want to emphasize the amount of an attribute value relative to the other values."
"To classify data into sets based on intervals of equal width, use the [equal interval](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.classify.equal_interval.html) function. The [equal interval classification](http://wiki.gis.com/wiki/index.php/Equal_Interval_classification) is useful in cases where you want to emphasize the amount of an attribute value relative to the other values."
]
},
{
Expand Down Expand Up @@ -251,7 +251,7 @@
"id": "a4630ca7",
"metadata": {},
"source": [
"To classify data based on quantile groups of equal size, use the [quantile](https://xarray-spatial.org/reference/_autosummary/xrspatial.classify.quantile.html) function. With [quantile classification](http://wiki.gis.com/wiki/index.php/Quantile), each class contains the same amount of data points. This means that each class is equally represented on the map. However, intervals of uneven sizes can lead to an over-weighting of outliers and other effects."
"To classify data based on quantile groups of equal size, use the [quantile](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.classify.quantile.html) function. With [quantile classification](http://wiki.gis.com/wiki/index.php/Quantile), each class contains the same amount of data points. This means that each class is equally represented on the map. However, intervals of uneven sizes can lead to an over-weighting of outliers and other effects."
]
},
{
Expand Down Expand Up @@ -281,7 +281,7 @@
"id": "13f0851f",
"metadata": {},
"source": [
"To define your own arbitrary bins to classify data, use the [reclassify](https://xarray-spatial.org/reference/_autosummary/xrspatial.classify.reclassify.html) function. This function is helpful to highlight specific sections of your data, for example. Use `reclassify()` to only visualize elevations greater than 2500m:"
"To define your own arbitrary bins to classify data, use the [reclassify](https://xarray-spatial.readthedocs.io/reference/_autosummary/xrspatial.classify.reclassify.html) function. This function is helpful to highlight specific sections of your data, for example. Use `reclassify()` to only visualize elevations greater than 2500m:"
]
},
{
Expand Down Expand Up @@ -320,7 +320,7 @@
"source": [
"The [Microsoft Planetary Computer Data Catalog](https://planetarycomputer.microsoft.com/catalog) includes petabytes of environmental monitoring data. All data sets are available in consistent, analysis-ready formats. You can access them through APIs as well as directly via [Azure Storage](https://docs.microsoft.com/en-us/azure/storage/). \n",
"\n",
"Try using [xarray-spatial's](https://xarray-spatial.org/index.html) classification methods with these datasets:"
"Try using [xarray-spatial's](https://xarray-spatial.readthedocs.io/index.html) classification methods with these datasets:"
]
},
{
Expand Down