example_wss.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "ef7d34c4",
   "metadata": {},
   "outputs": [],
   "source": [
    "# import the pysda package\n",
    "import sys\n",
    "sys.path.insert(1, r'C:\\Users\\Charles.Ferguson\\Documents\\GitHub\\pysda')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "978af985",
   "metadata": {},
   "outputs": [],
   "source": [
    "# let's check out the www.avaiablitlty function\n",
    "# this let's you download SSURGO availablity\n",
    "# as pdf, jpg, or shp (zipped) this is default\n",
    "import wss\n",
    "wss.availability(form=None, dest=r'C:\\temp\\test')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "d4ef8ea1",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>areasymbol</th>\n",
       "      <th>state</th>\n",
       "      <th>areaname</th>\n",
       "      <th>saverest</th>\n",
       "      <th>URL</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>TX299</td>\n",
       "      <td>TX</td>\n",
       "      <td>Llano County, Texas</td>\n",
       "      <td>9/13/2021 8:48:14 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>TX303</td>\n",
       "      <td>TX</td>\n",
       "      <td>Lubbock County, Texas</td>\n",
       "      <td>9/13/2021 8:48:14 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>TX305</td>\n",
       "      <td>TX</td>\n",
       "      <td>Lynn County, Texas</td>\n",
       "      <td>9/8/2021 9:03:02 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>TX307</td>\n",
       "      <td>TX</td>\n",
       "      <td>McCulloch County, Texas</td>\n",
       "      <td>9/13/2021 8:48:14 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>TX309</td>\n",
       "      <td>TX</td>\n",
       "      <td>McLennan County, Texas</td>\n",
       "      <td>9/8/2021 9:03:02 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "  areasymbol state                 areaname              saverest  \\\n",
       "0      TX299    TX      Llano County, Texas  9/13/2021 8:48:14 PM   \n",
       "1      TX303    TX    Lubbock County, Texas  9/13/2021 8:48:14 PM   \n",
       "2      TX305    TX       Lynn County, Texas   9/8/2021 9:03:02 PM   \n",
       "3      TX307    TX  McCulloch County, Texas  9/13/2021 8:48:14 PM   \n",
       "4      TX309    TX   McLennan County, Texas   9/8/2021 9:03:02 PM   \n",
       "\n",
       "                                                 URL  \n",
       "0  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "1  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "2  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "3  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "4  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  "
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# next if we want to download\n",
    "# soil survey areas we need to get\n",
    "# some basic info so we can get the \n",
    "# download urls\n",
    "allssa = wss.ssurgo()\n",
    "allssa.head()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "a60e13b2",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>areasymbol</th>\n",
       "      <th>state</th>\n",
       "      <th>areaname</th>\n",
       "      <th>saverest</th>\n",
       "      <th>URL</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>DE001</td>\n",
       "      <td>DE</td>\n",
       "      <td>Kent County, Delaware</td>\n",
       "      <td>8/26/2021 12:04:43 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>DE003</td>\n",
       "      <td>DE</td>\n",
       "      <td>New Castle County, Delaware</td>\n",
       "      <td>8/26/2021 12:04:43 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>DE005</td>\n",
       "      <td>DE</td>\n",
       "      <td>Sussex County, Delaware</td>\n",
       "      <td>8/26/2021 12:04:43 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "  areasymbol state                     areaname               saverest  \\\n",
       "0      DE001    DE        Kent County, Delaware  8/26/2021 12:04:43 PM   \n",
       "1      DE003    DE  New Castle County, Delaware  8/26/2021 12:04:43 PM   \n",
       "2      DE005    DE      Sussex County, Delaware  8/26/2021 12:04:43 PM   \n",
       "\n",
       "                                                 URL  \n",
       "0  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "1  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "2  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  "
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# that was all of the areas\n",
    "# most people will never want that\n",
    "# so we can filter on either a state\n",
    "# such as 'CA' or search the areanames\n",
    "state = wss.ssurgo(state='DE')\n",
    "state.head()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "b26083d9",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>areasymbol</th>\n",
       "      <th>state</th>\n",
       "      <th>areaname</th>\n",
       "      <th>saverest</th>\n",
       "      <th>URL</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>TX193</td>\n",
       "      <td>TX</td>\n",
       "      <td>Hamilton County, Texas</td>\n",
       "      <td>9/8/2021 8:30:44 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>KS075</td>\n",
       "      <td>KS</td>\n",
       "      <td>Hamilton County, Kansas</td>\n",
       "      <td>9/14/2021 12:11:23 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>NY041</td>\n",
       "      <td>NY</td>\n",
       "      <td>Hamilton County, New York</td>\n",
       "      <td>9/1/2021 9:50:52 AM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>FL047</td>\n",
       "      <td>FL</td>\n",
       "      <td>Hamilton County, Florida</td>\n",
       "      <td>9/2/2021 7:34:52 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>OH061</td>\n",
       "      <td>OH</td>\n",
       "      <td>Hamilton County, Ohio</td>\n",
       "      <td>9/8/2021 6:20:47 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>NE081</td>\n",
       "      <td>NE</td>\n",
       "      <td>Hamilton County, Nebraska</td>\n",
       "      <td>9/13/2021 8:18:26 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>IA079</td>\n",
       "      <td>IA</td>\n",
       "      <td>Hamilton County, Iowa</td>\n",
       "      <td>9/14/2021 8:28:01 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>IL065</td>\n",
       "      <td>IL</td>\n",
       "      <td>Hamilton County, Illinois</td>\n",
       "      <td>8/31/2021 1:02:41 AM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>IN057</td>\n",
       "      <td>IN</td>\n",
       "      <td>Hamilton County, Indiana</td>\n",
       "      <td>9/9/2021 11:36:55 AM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>TN065</td>\n",
       "      <td>TN</td>\n",
       "      <td>Hamilton County, Tennessee</td>\n",
       "      <td>9/10/2021 2:10:34 AM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "  areasymbol state                    areaname               saverest  \\\n",
       "0      TX193    TX      Hamilton County, Texas    9/8/2021 8:30:44 PM   \n",
       "1      KS075    KS     Hamilton County, Kansas  9/14/2021 12:11:23 PM   \n",
       "2      NY041    NY   Hamilton County, New York    9/1/2021 9:50:52 AM   \n",
       "3      FL047    FL    Hamilton County, Florida    9/2/2021 7:34:52 PM   \n",
       "4      OH061    OH       Hamilton County, Ohio    9/8/2021 6:20:47 PM   \n",
       "5      NE081    NE   Hamilton County, Nebraska   9/13/2021 8:18:26 PM   \n",
       "6      IA079    IA       Hamilton County, Iowa   9/14/2021 8:28:01 PM   \n",
       "7      IL065    IL   Hamilton County, Illinois   8/31/2021 1:02:41 AM   \n",
       "8      IN057    IN    Hamilton County, Indiana   9/9/2021 11:36:55 AM   \n",
       "9      TN065    TN  Hamilton County, Tennessee   9/10/2021 2:10:34 AM   \n",
       "\n",
       "                                                 URL  \n",
       "0  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "1  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "2  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "3  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "4  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "5  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "6  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "7  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "8  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "9  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  "
      ]
     },
     "execution_count": 5,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# wee see that the filter worked\n",
    "# because there are only 3 areas\n",
    "# in Deleware. Now lets try a search filter\n",
    "# note you can't use state and search together\n",
    "hamilton = wss.ssurgo(search='hamilton')\n",
    "hamilton"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "id": "ac95ec5c",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>areasymbol</th>\n",
       "      <th>state</th>\n",
       "      <th>areaname</th>\n",
       "      <th>saverest</th>\n",
       "      <th>URL</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>FL047</td>\n",
       "      <td>FL</td>\n",
       "      <td>Hamilton County, Florida</td>\n",
       "      <td>9/2/2021 7:34:52 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>OH061</td>\n",
       "      <td>OH</td>\n",
       "      <td>Hamilton County, Ohio</td>\n",
       "      <td>9/8/2021 6:20:47 PM</td>\n",
       "      <td>https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "  areasymbol state                  areaname             saverest  \\\n",
       "3      FL047    FL  Hamilton County, Florida  9/2/2021 7:34:52 PM   \n",
       "4      OH061    OH     Hamilton County, Ohio  9/8/2021 6:20:47 PM   \n",
       "\n",
       "                                                 URL  \n",
       "3  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  \n",
       "4  https://websoilsurvey.sc.egov.usda.gov/DSD/Dow...  "
      ]
     },
     "execution_count": 6,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# looks like there are 10\n",
    "# lets filter our data frame\n",
    "# to just get a few.\n",
    "import re\n",
    "hamilton = hamilton[hamilton['areaname'].str.contains('ohi|flo', flags = re.IGNORECASE)]\n",
    "hamilton"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "id": "14613a20",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Attempting download for FL047\n",
      "Attempting download for OH061\n"
     ]
    }
   ],
   "source": [
    "# now we can download the data\n",
    "# by passing, in this case, the \n",
    "# data frame.  this is preferrable\n",
    "# note the frame paramater can be any\n",
    "# iterable of valid URLs\n",
    "# additionally we will unpack these\n",
    "# and rename to convention \n",
    "wss.download(frame=hamilton, dest=r'C:\\temp\\test', unpack=True, rename=True)\n",
    "\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "id": "889fbc4d",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "['SoilDataAvailabilityShapefile.zip',\n",
       " 'soil_fl047',\n",
       " 'soil_oh061',\n",
       " 'wss_SSA_FL047_soildb_FL_2003_[2021-09-02].zip',\n",
       " 'wss_SSA_OH061_soildb_OH_2003_[2021-09-08].zip']"
      ]
     },
     "execution_count": 12,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# we can see that we have\n",
    "# received what we have asked for\n",
    "import os\n",
    "os.listdir(r'C:\\temp\\test')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "id": "a4a47354",
   "metadata": {
    "scrolled": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "148\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>state</th>\n",
       "      <th>areasymbol</th>\n",
       "      <th>saverest</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>NC</td>\n",
       "      <td>NC001</td>\n",
       "      <td>1/21/2022 11:11:27 AM</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>NC</td>\n",
       "      <td>NC003</td>\n",
       "      <td>1/21/2022 11:11:27 AM</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>NC</td>\n",
       "      <td>NC005</td>\n",
       "      <td>1/21/2022 11:11:27 AM</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>NC</td>\n",
       "      <td>NC007</td>\n",
       "      <td>1/21/2022 11:11:27 AM</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>NC</td>\n",
       "      <td>NC009</td>\n",
       "      <td>1/21/2022 11:11:27 AM</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "  state areasymbol               saverest\n",
       "0    NC      NC001  1/21/2022 11:11:27 AM\n",
       "1    NC      NC003  1/21/2022 11:11:27 AM\n",
       "2    NC      NC005  1/21/2022 11:11:27 AM\n",
       "3    NC      NC007  1/21/2022 11:11:27 AM\n",
       "4    NC      NC009  1/21/2022 11:11:27 AM"
      ]
     },
     "execution_count": 10,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# soils data is refreshed annually\n",
    "# around Oct. 1.  Sometimes surveys\n",
    "# are refreshed outside this annual \n",
    "# refresh  to see if you have the\n",
    "# most up-to-date you can run the\n",
    "# outofcycle function\n",
    "# so far this year there are 148\n",
    "ooc = wss.outofcycle()\n",
    "print(len(ooc))\n",
    "ooc.head()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.12"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}