Metadata-Version: 2.1
Name: asf_search
Version: 0.4.0
Summary: Python wrapper for ASF's SearchAPI
Home-page: https://github.com/asfadmin/Discovery-asf_search.git
Author: Alaska Satellite Facility Discovery Team
Author-email: uaf-asf-discovery@alaska.edu
License: BSD
Description: # asf_search
        
        [![PyPI version](https://img.shields.io/pypi/v/asf_search.svg)](https://pypi.python.org/pypi/asf_search/)
        [![Conda version](https://img.shields.io/conda/vn/conda-forge/asf_search)](https://anaconda.org/conda-forge/asf_search)
        
        [![PyPI pyversions](https://img.shields.io/pypi/pyversions/asf_search.svg)](https://pypi.python.org/pypi/asf_search/)
        [![PyPI license](https://img.shields.io/pypi/l/asf_search.svg)](https://pypi.python.org/pypi/asf_search/)
        
        [![CodeFactor](https://www.codefactor.io/repository/github/asfadmin/discovery-asf_search/badge)](https://www.codefactor.io/repository/github/asfadmin/discovery-asf_search)
        [![Github workflow](https://github.com/asfadmin/asf_search/actions/workflows/run-pytest.yml/badge.svg)](https://github.com/asfadmin/Discovery-asf_search/actions/workflows/run-pytest.yml)
        
        Python wrapper for the ASF SearchAPI
        
        ```python
        import asf_search as asf
        import json
        
        results = asf.granule_search(['ALPSRS279162400', 'ALPSRS279162200'])
        print(f'Granule search results: {json.dumps(results, indent=2)}')
        
        wkt = 'POLYGON((-135.7 58.2,-136.6 58.1,-135.8 56.9,-134.6 56.1,-134.9 58.0,-135.7 58.2))'
        results = asf.geo_search(platform=[asf.PLATFORM.SENTINEL1], intersectsWith=wkt, maxResults=10)
        print(f'Geographic search results: {json.dumps(results, indent=2)}')
        ```
        
        ## Install
        
        In order to easily manage dependencies, we recommend using dedicated project environments
        via [Anaconda/Miniconda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html)
        or [Python virtual environments](https://docs.python.org/3/tutorial/venv.html). 
        
        asf_search can be installed into a conda environment with
        
        ```
        conda install -c conda-forge asf_search
        ```
        
        or into a virtual environment with
        
        ```
        python -m pip install asf_search
        ```
        ## Usage
        
        Programmatically searching for ASF data is made simple with asf_search. Several search functions are provided:
        - `geo_search()` Find product info over an area of interest using a WKT string
        - `granule_search()` Find product info using a list of scenes
        - `product_search()` Find product info using a list of products
        - `search()` Find product info using any combination combination of search parameters
        - `stack()` Find a baseline stack of products using a reference scene
        - Additionally, numerous constants are provided to ease the search process
        
        Examples of all of the above can be found in `examples/`
        
        
        ## Development
        
        ### Branching
        
        <table>
          <thead>
            <tr>
              <th>Instance</th>
              <th>Branch</th>
              <th>Description, Instructions, Notes</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>Stable</td>
              <td>stable</td>
              <td>Accepts merges from Working and Hotfixes</td>
            </tr>
            <tr>
              <td>Working</td>
              <td>master</td>
              <td>Accepts merges from Features/Issues and Hotfixes</td>
            </tr>
            <tr>
              <td>Features/Issues</td>
              <td>topic-*</td>
              <td>Always branch off HEAD of Working</td>
            </tr>
            <tr>
              <td>Hotfix</td>
              <td>hotfix-*</td>
              <td>Always branch off Stable</td>
            </tr>
          </tbody>
        </table>
        
        For an extended description of our workflow, see https://gist.github.com/digitaljhelms/4287848
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Hydrology
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
