Open-EO / Open-EO/openeo-python-client

drop `extra-indices-dict.json` (and provide alternative mechanism for custom indices)

Open
#506 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clean up feature request technical debt
Dominant language
Python
Stars
217
Forks
56
Avg merge
1d 22h
Merged PRs (30d)
2

Description

the (Awesome) Spectral Indices implementation in openeo had a extra-indices-dict.json file with additional index definitions from the beginning, but @mbuchhorn correctly points out in #501 that this is a design error as it blindly overwrites indices Awesome Spectral Indices with a colliding name (e.g. NDGI, NDMI and S2WI at the moment).

I already removed the colliding indices NDGI, NDMI and S2WI from extra-indices-dict.json in 08cf2aa317a0ca23d1da952ba8139798184161a9

I think we should get rid of extra-indices-dict.json as a whole and think of another mechanism to work with custom index definitions

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting extra-indices-dict.json and the discussion in issue #501, including commit 08cf2aa317a0ca23d1da952ba8139798184161a. Determine how custom index definitions should be provided without overwriting Awesome Spectral Indices entries; the work is done when the file is removed and a decided alternative mechanism is documented and supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.