SarPy
=====
SarPy is a basic Python library to read, write, and do simple processing
of complex SAR data using the NGA SICD format *(standards linked below)*.
It has been released by NGA to encourage the use of SAR data standards
throughout the international SAR community. SarPy complements the
[SIX](https://github.com/ngageoint/six-library) library (C++) and the
[MATLAB SAR Toolbox](https://github.com/ngageoint/MATLAB_SAR), which are
implemented in other languages but have similar goals.
Some sample SICD files can be found
[here](https://github.com/ngageoint/six-library/wiki/Sample-SICDs).
Relevant Standards Documents
----------------------------
A variety of SAR format standard are mentioned throughout this ReadMe, here are
associated references.
*Sensor Independent Complex Data (SICD)* - latest version (1.3.0; 2021-11-30)
1. [Volume 1, Design & Implementation Description Document](https://nsgreg.nga.mil/doc/view?i=5381)
2. [Volume 2, File Format Description Document](https://nsgreg.nga.mil/doc/view?i=5382)
3. [Volume 3, Image Projections Description Document](https://nsgreg.nga.mil/doc/view?i=5383)
4. [Schema](https://nsgreg.nga.mil/doc/view?i=5418)
*Sensor Independent Derived Data (SIDD)* - latest version (3.0; 2021-11-30)
1. [Volume 1, Design and Implementation Description Document](https://nsgreg.nga.mil/doc/view?i=5440)
2. [Volume 2, NITF File Format Description Document]( https://nsgreg.nga.mil/doc/view?i=5441)
3. [Volume 3, GeoTIFF File Format Description Document](https://nsgreg.nga.mil/doc/view?i=5442)
4. [Schema](https://nsgreg.nga.mil/doc/view?i=5231)
*Compensated Phase History Data (CPHD)* - latest version (1.1.0; 2021-11-30)
1. [Design & Implementation Description](https://nsgreg.nga.mil/doc/view?i=5388)
2. [Design & Implementation Schema](https://nsgreg.nga.mil/doc/view?i=5421)
Both SICD and SIDD files are NITF files following specific guidelines
*Basic Image Interchange Format (BIFF)* - latest edition (2021.2; 2021-04-20)
1. [National Imagery Transmission Format](https://nsgreg.nga.mil/doc/view?i=5262)
For other NGA standards inquiries, the standards registry can be searched
[here](https://nsgreg.nga.mil/registries/search/index.jsp?registryType=doc).
Basic Capability
----------------
The basic capabilities provided in SarPy is generally SAR specific, and largely
geared towards reading and manipulating data provided in NGA SAR file formats.
Full support for reading and writing SICD, SIDD, CPHD, and CRSD (standard pending)
and associated metadata structures is currently provided, and this is the main
focus of this project.
There is additionally support for reading data from complex data formats analogous
to SICD format, *usually called Single Look Complex (SLC) or Level 1*, from a
variety of commercial or other sources including
- Capella (**partial support**)
- COSMO-SkyMed (1st and 2nd generation)
- GFF (Sandia format)
- ICEYE
- NISAR
- PALSAR2
- RadarSat-2
- Radar Constellation Mission (RCM)
- Sentinel-1
- TerraSAR-X.
For this SLC format data, it is read directly as though it were coming from a SICD
file. *This ability to read does not generally apply to data products other
than the SLC or Level 1 product, and there is typically no direct NGA standard
analog for these products.*
Some general TIFF and NITF reading support is provided, but this is not the main
goal of the SarPy library.
Documentation
-------------
Documentation for the project is available at
[readthedocs](https://sarpy.readthedocs.io/en/latest/).
If this documentation is inaccessible, it can be built locally after checking out
this repository using sphinx via the command `python setup.py build_sphinx`.
This depends on python package `sphinx`.
Origins
-------
SarPy was developed at the National Geospatial-Intelligence Agency (NGA). The
software use, modification, and distribution rights are stipulated within the
MIT license.
Dependencies
------------
The core library functionality depends only on `numpy` and `scipy`.
Optional Dependencies and Behavior
----------------------------------
There are a small collection of dependencies representing functionality which may
not be core requirements for much of the sarpy targeted tasks. The tension between
requiring the least extensive list of dependencies possible for core functionality
and not having surprise unstated dependencies which caused unexpected failures is
evident here. It is evident that there are many viable arguments for making any
or all of these formally stated dependencies. The choices made here are guided by
practical realities versus what is generally considered best practices.
For all packages on this list, the import is tried (where relevant), and any
import errors for these optional dependencies are caught and handled. In other words,
a missing optional dependency **will not** be presented as import time. Excepting
the functionality requiring `h5py`, this import error handling is probably silent.
Every module in sarpy can be successfully imported, provided that numpy and scipy
are in the environment. Attempts at using functionality depending on a missing
optional dependency will generate an error **at run time** with accompanying
message indicating the missing optional dependency.
- Support for reading single look complex data from certain sources which provide
data in hdf5 format require the `h5py` package, this includes Cosmo-Skymed, ICEYE,
and NISAR data.
- Reading an image segment in a NITF file using jpeg or jpeg 2000 compression,
reading a GeoTIFF DEM, and/or writing a kmz image overlay requires the `pillow`
package.
- CPHD consistency checks, presented in the `sarpy.consistency` module, depend on
`lxml>=4.1.1`, `networkx>=2.5`, `shapely>=1.6.4`, and `pytest>=3.3.2`. Note that these
are the versions tested for compliance.
- Some less commonly used (in the sarpy realm) NITF functionality requires the use
and interpretation of UTM coordinates, and this requires the `pyproj` package.
- Building sphinx documentation (mentioned below) requires packages `sphinx`,
and `sphinx_gallery`.
- Optional portions of running unit tests (unlikely to be of relevance to anyone
not performing development on the core sarpy package itself) require the `lxml`
package
Installation
------------
From PyPI, install using pip (may require escalated privileges e.g. sudo):
```bash
pip install sarpy
```
Note that here `pip` represents the pip utility for the desired Python environment.
For verbose instructions for installing from source, see
[here](https://docs.python.org/3/install/index.html). It is recommended that
still the package is built locally and installed using pip, which allows a proper
package update mechanism, while `python setup.py install` **does not**.
Issues and Bugs
---------------
Support for Python 2 has been dropped. The core sarpy functionality has been
tested for Python 3.6, 3.7, 3.8, 3.9, 3.10, and 3.11.
Changes to sarpy for the sole purpose of supporting a Python version beyond
end-of-life are unlikely to be considered.
Information regarding any discovered bugs would be greatly appreciated, so please
feel free to create a GitHub issue. If more appropriate, contact richard.m.naething@nga.mil.
Integration Branches
--------------------
Integration branches (branches prefixed with `integration/`) are used to stage content under
consideration for inclusion in the `master` branch and future SarPy releases.
These branches can be used to access features and bug fixes that have not been fully released.
Pull Requests
-------------
Efforts at direct contribution to the project are certainly welcome, and please
feel free to make a pull request. Pull requests should be authored against the `master`
branch but may be retargeted to a suitable integration branch upon review.
Note that any and all contributions to this project will be released under the MIT license.
Software source code previously released under an open source license and then
modified by NGA staff is considered a "joint work" (see 17 USC 101); it is partially
copyrighted, partially public domain, and as a whole is protected by the copyrights
of the non-government authors and must be released according to the terms of the
original open source license.
Associated GUI Capabilities
---------------------------
Some associated SAR specific graphical user interface tools are maintained in the
[sarpy_apps project](https://github.com/ngageoint/sarpy_apps).
Raw data
{
"_id": null,
"home_page": "https://github.com/ngageoint/sarpy",
"name": "sarpy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "National Geospatial-Intelligence Agency",
"author_email": "richard.m.naething@nga.mil",
"download_url": "https://files.pythonhosted.org/packages/da/a8/221acbbfac5d5774f7dd39659c9ed64a0dca3322c97726c4b12e45cdaa9d/sarpy-1.3.59.tar.gz",
"platform": "any",
"description": "SarPy\n=====\nSarPy is a basic Python library to read, write, and do simple processing\nof complex SAR data using the NGA SICD format *(standards linked below)*. \nIt has been released by NGA to encourage the use of SAR data standards\nthroughout the international SAR community. SarPy complements the\n[SIX](https://github.com/ngageoint/six-library) library (C++) and the\n[MATLAB SAR Toolbox](https://github.com/ngageoint/MATLAB_SAR), which are\nimplemented in other languages but have similar goals.\n\nSome sample SICD files can be found \n[here](https://github.com/ngageoint/six-library/wiki/Sample-SICDs).\n\nRelevant Standards Documents\n----------------------------\nA variety of SAR format standard are mentioned throughout this ReadMe, here are \nassociated references. \n\n*Sensor Independent Complex Data (SICD)* - latest version (1.3.0; 2021-11-30)\n\n1. [Volume 1, Design & Implementation Description Document](https://nsgreg.nga.mil/doc/view?i=5381)\n2. [Volume 2, File Format Description Document](https://nsgreg.nga.mil/doc/view?i=5382)\n3. [Volume 3, Image Projections Description Document](https://nsgreg.nga.mil/doc/view?i=5383)\n4. [Schema](https://nsgreg.nga.mil/doc/view?i=5418)\n\n*Sensor Independent Derived Data (SIDD)* - latest version (3.0; 2021-11-30)\n1. [Volume 1, Design and Implementation Description Document](https://nsgreg.nga.mil/doc/view?i=5440)\n2. [Volume 2, NITF File Format Description Document]( https://nsgreg.nga.mil/doc/view?i=5441)\n3. [Volume 3, GeoTIFF File Format Description Document](https://nsgreg.nga.mil/doc/view?i=5442)\n4. [Schema](https://nsgreg.nga.mil/doc/view?i=5231)\n\n*Compensated Phase History Data (CPHD)* - latest version (1.1.0; 2021-11-30)\n1. [Design & Implementation Description](https://nsgreg.nga.mil/doc/view?i=5388)\n2. [Design & Implementation Schema](https://nsgreg.nga.mil/doc/view?i=5421)\n\nBoth SICD and SIDD files are NITF files following specific guidelines\n*Basic Image Interchange Format (BIFF)* - latest edition (2021.2; 2021-04-20)\n1. [National Imagery Transmission Format](https://nsgreg.nga.mil/doc/view?i=5262)\n\nFor other NGA standards inquiries, the standards registry can be searched\n\n[here](https://nsgreg.nga.mil/registries/search/index.jsp?registryType=doc).\n \nBasic Capability\n----------------\nThe basic capabilities provided in SarPy is generally SAR specific, and largely \ngeared towards reading and manipulating data provided in NGA SAR file formats. \nFull support for reading and writing SICD, SIDD, CPHD, and CRSD (standard pending) \nand associated metadata structures is currently provided, and this is the main \nfocus of this project.\n\nThere is additionally support for reading data from complex data formats analogous \nto SICD format, *usually called Single Look Complex (SLC) or Level 1*, from a \nvariety of commercial or other sources including \n- Capella (**partial support**)\n- COSMO-SkyMed (1st and 2nd generation)\n- GFF (Sandia format)\n- ICEYE\n- NISAR\n- PALSAR2\n- RadarSat-2\n- Radar Constellation Mission (RCM)\n- Sentinel-1\n- TerraSAR-X.\n\nFor this SLC format data, it is read directly as though it were coming from a SICD \nfile. *This ability to read does not generally apply to data products other \nthan the SLC or Level 1 product, and there is typically no direct NGA standard \nanalog for these products.*\n\nSome general TIFF and NITF reading support is provided, but this is not the main \ngoal of the SarPy library.\n\nDocumentation\n-------------\nDocumentation for the project is available at \n[readthedocs](https://sarpy.readthedocs.io/en/latest/).\n\nIf this documentation is inaccessible, it can be built locally after checking out \nthis repository using sphinx via the command `python setup.py build_sphinx`. \nThis depends on python package `sphinx`.\n\nOrigins\n-------\nSarPy was developed at the National Geospatial-Intelligence Agency (NGA). The \nsoftware use, modification, and distribution rights are stipulated within the \nMIT license.\n\nDependencies\n------------\nThe core library functionality depends only on `numpy` and `scipy`. \n\nOptional Dependencies and Behavior\n----------------------------------\nThere are a small collection of dependencies representing functionality which may \nnot be core requirements for much of the sarpy targeted tasks. The tension between\nrequiring the least extensive list of dependencies possible for core functionality \nand not having surprise unstated dependencies which caused unexpected failures is \nevident here. It is evident that there are many viable arguments for making any \nor all of these formally stated dependencies. The choices made here are guided by \npractical realities versus what is generally considered best practices.\n\nFor all packages on this list, the import is tried (where relevant), and any \nimport errors for these optional dependencies are caught and handled. In other words, \na missing optional dependency **will not** be presented as import time. Excepting \nthe functionality requiring `h5py`, this import error handling is probably silent. \n\nEvery module in sarpy can be successfully imported, provided that numpy and scipy \nare in the environment. Attempts at using functionality depending on a missing \noptional dependency will generate an error **at run time** with accompanying \nmessage indicating the missing optional dependency.\n\n- Support for reading single look complex data from certain sources which provide \n data in hdf5 format require the `h5py` package, this includes Cosmo-Skymed, ICEYE, \n and NISAR data.\n\n- Reading an image segment in a NITF file using jpeg or jpeg 2000 compression,\n reading a GeoTIFF DEM, and/or writing a kmz image overlay requires the `pillow` \n package.\n\n- CPHD consistency checks, presented in the `sarpy.consistency` module, depend on \n `lxml>=4.1.1`, `networkx>=2.5`, `shapely>=1.6.4`, and `pytest>=3.3.2`. Note that these\n are the versions tested for compliance.\n\n- Some less commonly used (in the sarpy realm) NITF functionality requires the use \n and interpretation of UTM coordinates, and this requires the `pyproj` package. \n\n- Building sphinx documentation (mentioned below) requires packages `sphinx`, \n and `sphinx_gallery`.\n\n- Optional portions of running unit tests (unlikely to be of relevance to anyone \n not performing development on the core sarpy package itself) require the `lxml`\n package\n\nInstallation\n------------\nFrom PyPI, install using pip (may require escalated privileges e.g. sudo):\n```bash\npip install sarpy\n```\nNote that here `pip` represents the pip utility for the desired Python environment.\n\nFor verbose instructions for installing from source, see \n[here](https://docs.python.org/3/install/index.html). It is recommended that \nstill the package is built locally and installed using pip, which allows a proper \npackage update mechanism, while `python setup.py install` **does not**.\n\nIssues and Bugs\n---------------\nSupport for Python 2 has been dropped. The core sarpy functionality has been \ntested for Python 3.6, 3.7, 3.8, 3.9, 3.10, and 3.11. \n\nChanges to sarpy for the sole purpose of supporting a Python version beyond \nend-of-life are unlikely to be considered.\n\nInformation regarding any discovered bugs would be greatly appreciated, so please\nfeel free to create a GitHub issue. If more appropriate, contact richard.m.naething@nga.mil.\n\nIntegration Branches\n--------------------\nIntegration branches (branches prefixed with `integration/`) are used to stage content under\nconsideration for inclusion in the `master` branch and future SarPy releases.\nThese branches can be used to access features and bug fixes that have not been fully released.\n\nPull Requests\n-------------\nEfforts at direct contribution to the project are certainly welcome, and please\nfeel free to make a pull request. Pull requests should be authored against the `master`\nbranch but may be retargeted to a suitable integration branch upon review.\nNote that any and all contributions to this project will be released under the MIT license.\n\nSoftware source code previously released under an open source license and then \nmodified by NGA staff is considered a \"joint work\" (see 17 USC 101); it is partially \ncopyrighted, partially public domain, and as a whole is protected by the copyrights \nof the non-government authors and must be released according to the terms of the \noriginal open source license.\n\nAssociated GUI Capabilities\n---------------------------\nSome associated SAR specific graphical user interface tools are maintained in the \n[sarpy_apps project](https://github.com/ngageoint/sarpy_apps). \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python tools for reading, writing, and simple processing of complex SAR data and other associated data.",
"version": "1.3.59",
"project_urls": {
"Homepage": "https://github.com/ngageoint/sarpy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9472d52b65b0db0a8025bc7fe7c184bca9c0cd740fe968948ebbd9e10937b866",
"md5": "c39f8edd4cbd7450a0f216ffbb3f565a",
"sha256": "b0fd9ba9d9306967a2307e981067cadb3287c39aa5c7b50244d86cecfc960748"
},
"downloads": -1,
"filename": "sarpy-1.3.59-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "c39f8edd4cbd7450a0f216ffbb3f565a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 1641457,
"upload_time": "2024-10-03T23:24:17",
"upload_time_iso_8601": "2024-10-03T23:24:17.842926Z",
"url": "https://files.pythonhosted.org/packages/94/72/d52b65b0db0a8025bc7fe7c184bca9c0cd740fe968948ebbd9e10937b866/sarpy-1.3.59-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "daa8221acbbfac5d5774f7dd39659c9ed64a0dca3322c97726c4b12e45cdaa9d",
"md5": "b36e7ab5e034ce404334d497664a1860",
"sha256": "916fc14ddb77a0a2a8fd6961b7865167cfa603ec7510412d9494c587cd44eb3c"
},
"downloads": -1,
"filename": "sarpy-1.3.59.tar.gz",
"has_sig": false,
"md5_digest": "b36e7ab5e034ce404334d497664a1860",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1281450,
"upload_time": "2024-10-03T23:24:20",
"upload_time_iso_8601": "2024-10-03T23:24:20.092277Z",
"url": "https://files.pythonhosted.org/packages/da/a8/221acbbfac5d5774f7dd39659c9ed64a0dca3322c97726c4b12e45cdaa9d/sarpy-1.3.59.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-03 23:24:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ngageoint",
"github_project": "sarpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sarpy"
}
JSON
