Data

Tools

Indexes

Applications

Experiments

Open Source Science

isofit

Imaging Spectrometer Optimal FITting (ISOFIT) contains a set of routines and utilities for fitting surface, atmosphere and instrument models to imaging spectrometer data.

https://github.com/isofit/isofit

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    9 of 22 committers (40.9%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Imaging Spectrometer Optimal FITting (ISOFIT) contains a set of routines and utilities for fitting surface, atmosphere and instrument models to imaging spectrometer data.

Basic Info
  • Host: GitHub
  • Owner: isofit
  • License: apache-2.0
  • Language: Python
  • Default Branch: dev
  • Homepage:
  • Size: 97.5 MB
Statistics
  • Stars: 110
  • Watchers: 11
  • Forks: 83
  • Open Issues: 77
  • Releases: 61
Created over 7 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.rst 

=============================================
ISOFIT - Imaging Spectrometer Optimal FITting
=============================================

Welcome to ISOFIT 3x.  This is a major update to the ISOFIT codebase, and is not backwards compatible with ISOFIT 2x.
To view the previous version of ISOFIT, please see `dev_2x `__. Updates
and performance enhancements are still underway, but testing and feedback are encouraged! A list of new 3x features is
compiled below.


ISOFIT contains a set of routines and utilities for fitting surface, atmosphere and instrument models to imaging
spectrometer data. It is written primarily in Python, with JSON format configuration files and some dependencies on
widely-available numerical and scientific libraries such as scipy, numpy, and scikit-learn. It is designed for maximum
flexibility, so that users can swap in and evaluate model components based on different radiative transfer models (RTMs)
and various statistical descriptions of surface, instrument, and atmosphere. It can run on individual radiance spectra
in text format, or imaging spectrometer data cubes.

* Please check the documentation_ for installation and usage instructions and in depth information.

* There are three main branches:

 * `main `__ (in-line with the current release)
 * `dev `__ (for activate development of ISOFIT 3x)
 * `dev_2x `__ (archived version of ISOFIT 2x)

* Information on how to **cite the ISOFIT Python package** can be found in the
  `CITATION `__ file.


License
-------
Free software: Apache License v2

All images contained in any (sub-)directory of this repository are licensed under the CC0 license which can be found
`here `__.

Major ISOFIT 3x features
------------------------

* new handling of look-up-tables (LUTs), including the option to provide custom prebuilt LUTs
* centralized radiative transfer physics for more flexible development and experimentation
* test coverage for major functionality
* click command line utilities, including download of external data and example files
* a more flexible isofit.ini file used to discover various paths such as tests, data, and examples
* instructions for dev environment setup and a collection of setup scripts
* numpy implementation of the sRTMnet emulator (removes tensorflow dependency)

Basic features
--------------

* utilities for fitting surface, atmosphere and instrument models to imaging spectrometer data
* a selection of radiative transfer models (RTMs) incl. MODTRAN and 6S
* sRTMnet emulator for MODTRAN 6 by coupling a neural network with a surrogate RTM (6S v2.1)
* various statistical descriptions of surface, instrument, and atmosphere
* application to both individual radiance spectra and imaging spectrometer data cubes
* custom instrument models to handle new sensors
* observation uncertainties to account for model discrepancy errors
* prior distribution based on background knowledge of the state vector

Status
------

|badge1| |badge2| |badge3| |badge4| |badge5| |badge6| |badge7| |badge8|

.. |badge1| image:: https://img.shields.io/static/v1?label=Documentation&message=readthedocs&color=blue
    :target: https://isofit.readthedocs.io/en/latest/index.html

.. |badge2| image:: https://readthedocs.org/projects/pip/badge/?version=stable
    :target: https://pip.pypa.io/en/stable/?badge=stable

.. |badge3| image:: https://img.shields.io/pypi/v/isofit.svg
    :target: https://pypi.python.org/pypi/isofit

.. |badge4| image:: https://img.shields.io/conda/vn/conda-forge/isofit.svg
    :target: https://anaconda.org/conda-forge/isofit

.. |badge5| image:: https://img.shields.io/pypi/l/isofit.svg
    :target: https://github.com/isofit/isofit/blob/master/LICENSE

.. |badge6| image:: https://img.shields.io/pypi/pyversions/isofit.svg
    :target: https://img.shields.io/pypi/pyversions/isofit.svg

.. |badge7| image:: https://img.shields.io/pypi/dm/isofit.svg
    :target: https://pypi.python.org/pypi/isofit

.. |badge8| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.6908949.svg
   :target: https://doi.org/10.5281/zenodo.6908949

.. _documentation: https://isofit.readthedocs.io/en/latest/index.html

Owner

  • Name: isofit
  • Login: isofit
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
title: isofit
message: >-
  If you use this software for research we would appreciate
  appropriate citation. This may be prepared using the
  bibliographic metadata contained in our DOI, accessible
  through the DOI system and at
  https://doi.org/10.5281/zenodo.4614337. 

  If you use ISOFIT in your research or production, we ask that 
  you cite the precursor publication:
  Thompson, David R., Natraj, Vijay, Green, Robert O., Helmlinger, 
  Mark C., Gao, Bo-Cai, & Eastwood, Michael L. (2018). 
  Optimal estimation for imaging spectrometer atmospheric correction. 
  Remote Sensing of Environment 216, 355-373.
type: software
authors:
  - given-names: Philip G Brodrick
    affiliation: >-
      Jet Propulsion Laboratory, California Institute of
      Technology
    orcid: 'https://orcid.org/0000-0001-9497-7661'
  - given-names: David R Thompson
    affiliation: >-
      Jet Propulsion Laboratory, California Institute of
      Technology
    orcid: 'https://orcid.org/0000-0003-1100-7550'
  - given-names: Niklas Bohn
    affiliation: >-
      Jet Propulsion Laboratory, California Institute of
      Technology
    orcid: 'https://orcid.org/0000-0003-4078-886X'
  - given-names: Nimrod Carmon
    affiliation: >-
      Jet Propulsion Laboratory, California Institute of
      Technology
    orcid: 'https://orcid.org/0000-0002-9211-2290'
  - given-names: Regina Eckert
    affiliation: >-
      Jet Propulsion Laboratory, California Institute of
      Technology
    orcid: 'https://orcid.org/0000-0003-4571-7040'
  - given-names: James Montgomery
    affiliation: >-
      Jet Propulsion Laboratory, California Institute of
      Technology
  - given-names: Kevin Wurster
    affiliation: >-
      Planet Corporate Activities
  - given-names: Nicholas Vaughn
    affiliation: >-
      Arizona State University
    orcid: 'https://orcid.org/0000-0003-0428-2909'
  - given-names: Evan Greenberg 
    affiliation: >-
      Jet Propulsion Laboratory, California Institute of
      Technology
    orcid: 'https://orcid.org/0000-0002-4700-790X'

identifiers:
  - type: doi
    value: 10.5281/zenodo.4614337
license: Apache-2.0

GitHub Events

Total
  • Create event: 16
  • Release event: 18
  • Issues event: 70
  • Watch event: 24
  • Delete event: 1
  • Issue comment event: 252
  • Push event: 112
  • Pull request review comment event: 160
  • Pull request review event: 197
  • Pull request event: 243
  • Fork event: 4
Last Year
  • Create event: 16
  • Release event: 18
  • Issues event: 70
  • Watch event: 24
  • Delete event: 1
  • Issue comment event: 252
  • Push event: 112
  • Pull request review comment event: 160
  • Pull request review event: 197
  • Pull request event: 243
  • Fork event: 4

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 1,080
  • Total Committers: 22
  • Avg Commits per committer: 49.091
  • Development Distribution Score (DDS): 0.752
Past Year
  • Commits: 258
  • Committers: 9
  • Avg Commits per committer: 28.667
  • Development Distribution Score (DDS): 0.678
Top Committers
Name Email Commits
pgbrodrick p****k@g****m 268
David R Thompson d****n@j****v 186
Adam Erickson a****n@g****m 115
Brodrick p****k@j****v 99
unbohn n****8@g****m 83
Winston Olson-Duvall w****l@j****v 82
Jay E Fahlen j****n@j****v 58
James Montgomery g****b@b****v 51
James Montgomery j****o@j****v 39
David R Thompson d****n@g****m 35
Alexey Shiklomanov a****v@g****m 33
Shawn P. Serbin s****n@b****v 7
NimrodCarmon 5****n@u****m 5
--global -****l 3
unbohn 1****n@u****m 3
Dan Yu d****u@j****v 3
yshinozu Y****a@n****v 3
jfahlen 5****n@u****m 2
Varun Patro v****7@g****m 2
Adam Erickson a****n@u****m 1
carmon n****n@j****v 1
Lewis John McGibbney l****y@g****m 1
Committer Domains (Top 20 + Academic)
jpl.nasa.gov: 7 nasa.gov: 1 bnl.gov: 1 booms.dev: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 129
  • Total pull requests: 568
  • Average time to close issues: 8 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 27
  • Total pull request authors: 18
  • Average comments per issue: 1.13
  • Average comments per pull request: 1.57
  • Merged pull requests: 422
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 57
  • Pull requests: 290
  • Average time to close issues: 15 days
  • Average time to close pull requests: 9 days
  • Issue authors: 16
  • Pull request authors: 11
  • Average comments per issue: 0.61
  • Average comments per pull request: 1.22
  • Merged pull requests: 196
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • pgbrodrick (38)
  • jammont (14)
  • davidraythompson (13)
  • danschef (12)
  • unbohn (8)
  • evan-greenbrg (8)
  • adamchlus (5)
  • pl-kevinwurster (4)
  • sreid19 (4)
  • NickVaughn (3)
  • quarkpt (2)
  • ashiklom (2)
  • brobertspierel (2)
  • alexjohnson-kobold (1)
  • serbinsh (1)
Pull Request Authors
  • jammont (165)
  • pgbrodrick (129)
  • unbohn (117)
  • evan-greenbrg (62)
  • pl-kevinwurster (23)
  • davidraythompson (20)
  • adamchlus (11)
  • barentsen (8)
  • DKnapp64 (6)
  • danschef (6)
  • brentwilder (4)
  • NimrodCarmon (4)
  • varunpatro1 (4)
  • reginaeckert (3)
  • NickVaughn (2)
Top Labels
Issue Labels
bugfix (14) enhancement (7) cleanup (3) good first issue (2) help wanted (1)
Pull Request Labels
bugfix (114) enhancement (106) cleanup (23) question (2) help wanted (2)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 1,027 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 80
  • Total maintainers: 3
pypi.org: isofit

Imaging Spectrometer Optimal FITting

  • Documentation: https://isofit.readthedocs.io/
  • License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS
  • Latest release: 3.5.0
    published 8 months ago
  • Versions: 75
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 1,027 Last month
  • Docker Downloads: 0
Rankings
Forks count: 5.3%
Dependent packages count: 7.4%
Stargazers count: 8.4%
Average: 11.0%
Downloads: 11.8%
Dependent repos count: 22.2%
Maintainers (3)
brodrick davidraythompson winstonolson
Last synced: 6 months ago
conda-forge.org: isofit

ISOFIT contains a set of routines and utilities for fitting surface, atmosphere and instrument models to imaging spectrometer data

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Forks count: 22.4%
Dependent repos count: 34.0%
Average: 36.2%
Stargazers count: 37.1%
Dependent packages count: 51.2%
Last synced: 6 months ago

Dependencies

.github/workflows/py-hypertrace.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite
.github/workflows/utils-workflow.yml actions
  • actions/checkout v2 composite
Dockerfile docker
  • osgeo/gdal ubuntu-full-3.4.0 build
.github/workflows/example-testing.yml actions
  • actions/checkout v2 composite
.github/workflows/linter.yml actions
  • actions/checkout v2 composite
  • psf/black stable composite
.github/workflows/release.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
docs/source/requirements.txt pypi
  • sphinx >=3.1.0
  • sphinx-autodoc-typehints >=1.11.0
  • sphinx_rtd_theme *
  • sphinxcontrib-napoleon *
pyproject.toml pypi