[Django] #36036: Support the 4th dimension (M) in the GEOS API

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+---------------------------------------
Reporter: Andrew | Type: New feature
Status: new | Component: GIS
Version: 4.2 | Severity: Normal
Keywords: GIS 4d GESO | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------+---------------------------------------
The GEOS API supports a 4th dimension, M, as well as PostGIS.
Unfortunately Django does not and would be great if it could. I've started
a [WIP
branch](https://github.com/django/django/compare/main...andharris:django
:gis-4dim-support) to see what this could look like.
--
Ticket URL: <https://code.djangoproject.com/ticket/36036>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+--------------------------------------

Reporter: andharris | Owner: (none)

Type: New feature | Status: new
Component: GIS | Version: 4.2

Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Unreviewed

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------+--------------------------------------

Changes (by andharris):

* keywords: GIS 4d GESO => GIS 4d GEOS

--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:1>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+--------------------------------------

Reporter: Andrew | Owner: (none)
Type: New feature | Status: closed
Component: GIS | Version: 4.2
Severity: Normal | Resolution: needsinfo

Keywords: GIS 4d GEOS | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------+--------------------------------------

Changes (by Natalia Bidart):

* cc: Claude Paroz, Mariusz Felisiak, David Smith (added)
* resolution: => needsinfo
* status: new => closed

Comment:

Hello Andrew, thank you for taking the time to create this ticket.

I've been trying to search for examples and "real life" use cases for this
feature, I can see that Postgis supports the 4th-dimension but I'm not
finding practical use cases to justify including this into Django.
Basically we need to determine whether this would be used by niche use
cases, or if this is truly something that applies to the broader
ecosystem, since Django is a framework designed to offer robust and
accurate solutions for common scenarios.

I'm adding as CC a few experts in this topic to see what they think, but I
think the best path forward at this point is to start a new forum
conversation proposing this idea. The right category would be
[https://forum.djangoproject.com/c/internals/geodjango/13 GeoDjango]. In
there you'll reach a wider audience and get extra feedback. More
information in
[https://docs.djangoproject.com/en/stable/internals/contributing/bugs-and-
features/#requesting-features the documented guidelines for requesting
features].
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:2>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+--------------------------------------
Reporter: Andrew | Owner: (none)
Type: New feature | Status: closed
Component: GIS | Version: 4.2
Severity: Normal | Resolution: needsinfo
Keywords: GIS 4d GEOS | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------+--------------------------------------

Comment (by Tim Graham):

I asked "what is 4d geos" and AI Overview says, ""4D Geos" refers to a
field within geoscience that incorporates the element of time into spatial
data analysis, essentially creating a "four-dimensional" view of
geological processes or environmental changes by analyzing data across
both space and time; this often involves using advanced GIS (Geographic
Information Systems) tools to visualize and model these dynamic changes
over time, making it particularly useful for studying things like land use
changes, geological formations evolving over time, or environmental
impacts across different periods."

I'm not a GeoDjango user, but this doesn't appear to be a controversial
feature that requires a discussion. The changes appear straightforward and
it doesn't seem useful to require users to implement this functionality as
a third-party package or a subclass in every project that requires it.
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:3>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------

Reporter: Andrew | Owner: (none)
Type: New feature | Status: new
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Changes (by Claude Paroz):

* needs_better_patch: 0 => 1
* needs_docs: 0 => 1
* needs_tests: 0 => 1
* resolution: needsinfo =>
* stage: Unreviewed => Accepted
* status: closed => new
* version: 4.2 => dev

Comment:

I do agree with Tim. We strive (in longer term) to replicate as much as
possible the GEOS API, and this could be the next evolution in that trend.
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:4>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: (none)
Type: New feature | Status: new
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by Andrew):

Sorry for the silence over the holidays. Would it be worthwhile for me to
get my existing branch reviewable as PR with tests, docs, etc.? I'm not
sure the best process to getting an issue like this merged in. I'm happy
to help however is best but as Tim and Claude mentioned this is helping
GeoDjango support more of the GEOS API and the primary use case for this
4th dimension if for a time component of a geometry.
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:5>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: (none)
Type: New feature | Status: new
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by Natalia Bidart):

Andrew: yes, please! assign the issue to yourself and polish the PR. The
guide for contributing can be found
[https://docs.djangoproject.com/en/dev/internals/contributing/writing-
code/ here]. Let me know if you have any questions!
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:6>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------

Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned

Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Changes (by Andrew):

* owner: (none) => Andrew
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:7>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by Andrew):

[https://github.com/django/django/pull/19013 PR] is ready for review.
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:8>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Changes (by Andrew):

* needs_docs: 1 => 0
* needs_tests: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:9>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Description changed by Andrew:

Old description:

> The GEOS API supports a 4th dimension, M, as well as PostGIS.
> Unfortunately Django does not and would be great if it could. I've
> started a [WIP
> branch](https://github.com/django/django/compare/main...andharris:django
> :gis-4dim-support) to see what this could look like.

New description:

The GEOS API supports a 4th dimension, M, as well as PostGIS.
Unfortunately Django does not and would be great if it could. I've started

a [https://github.com/django/django/compare/main...andharris:django:gis-
4dim-support WIP branch] to see what this could look like.

--
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:10>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by Andrew):

It appears the test runner is using an out of date GEOS lib without
GEOSGeomGetM which was added in
[https://github.com/libgeos/geos/releases/tag/3.12.0 3.12.0]. Is it a
reasonable expectation to have geos updated to support this work?
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:11>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by Claude Paroz):

Django is keeping compatibility with GIS libs until ~5years after they've
been released. So Django will still support GEOS < 3.12 during the 2-3
next years (3.11 was released on July 2022).
In any case, your patch must take that into account and add conditional
support for the M dimension depending on the installed version. If this is
too difficult to achieve with reasonable efforts, I guess we'll have to
postpone that issue for later (and set the Someday/Maybe triage state).

Regarding the test runners, it might be indeed interesting to have at
least one config using the latest Ubuntu stable (see
https://code.djangoproject.com/wiki/CI for current configs).
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:12>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by Andrew):

That makes sense. I'll look into conditional support but if it seems like
a significant effort I can update the state of this issue. I'll also look
into adding another test runner config too. Thanks
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:13>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by Claude Paroz):

In any case, I think conditionally adding the `GEOSHasM` support could be
done (in its own PR/commit).
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:14>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by Andrew):

I've added the conditional support for `GEOSHasM` in a separate commit and
got CI to pass. Is the separate commit sufficient or are you thinking
there should be separate PRs? I wasn't sure how best these could be
separated into individual PRs in a meaningful way.

At the moment CI does not run the 4D tests because we don't have a test
runner configured to use GEOS > 3.12, but I have been able to successfully
run the tests locally on an up to date GEOS version. I wasn't sure where
we'd config the test runners to also test on a later version.
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:15>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by Claude Paroz):

A separate PR would be nice, as we can see test passing for that commit
only.

Other than that, I have the feeling that tests are missing for x/y/m
scenarios (M dimension without Z). But that could be discussed directly on
the PR.
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:16>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by Andrew):

Yeah it will require a little more refactor to support 3d where the third
dim is M not Z, but feel doable.

Is this [https://github.com/django/django/pull/19023 PR] the level of
isolation you were expecting for adding conditional support for
`GEOSHasM`?
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:17>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Changes (by Claude Paroz):

* needs_better_patch: 1 => 0

Comment:

Yes, it's the patch granularity I was expecting, thanks!

Even if it's not the final patch, I'm unchecking "Patch needs improvement"
so that the patch goes to the review queue.
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:18>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by Andrew):

I wanted to follow up with getting the separate PR approved to merge.
We've been waiting on some input but not sure when we might expect to get
final feedback. I'm happy to update however reviewers feel is best.

Additionally I've been struggling with the WKT writer to have it correctly
write XYM coordinates. I'm wondering if it would be acceptable to have an
initial PR merged that only supports the M dimension for 4D coordinates
(XYZM). I'm failing confidence the the primary use case for the M
dimension will be for XYZM and XYM would be a relatively niche use case.

Thanks again for all y'alls guidance and input on this issue.
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:19>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------
Comment (by Andrew):

I've addressed PR feedback in the small
[https://github.com/django/django/pull/19023 GEOSHasM PR]. Is there
anything else I can do help get it merged?

Also still curious if it'd be acceptable to first patch to support XYZM
coordinates and then separately add XYM should that need arise?
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:20>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Changes (by Sarah Boyce):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:21>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API

-----------------------------+---------------------------------------------

Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:

Keywords: GIS 4d GEOS | Triage Stage: Ready for checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0

-----------------------------+---------------------------------------------
Changes (by Sarah Boyce):

* needs_better_patch: 1 => 0
* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:22>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+---------------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Ready for checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------+---------------------------------------------

Comment (by Sarah Boyce <42296566+sarahboyce@…>):

In [changeset:"5f30fd2358fd60a514bdba31594bfc8122f30167" 5f30fd2]:
{{{#!CommitTicketReference repository=""
revision="5f30fd2358fd60a514bdba31594bfc8122f30167"
Refs #36036 -- Added support for GEOSHasM.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:23>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------

Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:

Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Changes (by Sarah Boyce):

* has_patch: 1 => 0
* stage: Ready for checkin => Accepted

--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:24>

[Django]

#36036: Support the 4th dimension (M) in the GEOS API
-----------------------------+------------------------------------
Reporter: Andrew | Owner: Andrew
Type: New feature | Status: assigned
Component: GIS | Version: dev
Severity: Normal | Resolution:
Keywords: GIS 4d GEOS | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-----------------------------+------------------------------------

Comment (by GitHub <noreply@…>):

In [changeset:"2d1ac1dce8a1c169def5af01fc871e33f93c27c3" 2d1ac1dc]:
{{{#!CommitTicketReference repository=""
revision="2d1ac1dce8a1c169def5af01fc871e33f93c27c3"
Refs #36036 -- Removed unsupported 4D GEOS tests.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36036#comment:25>