feat: soil id endpoints

terraso_backend/apps/graphql/schema/__init__.py

@@ -41,6 +41,7 @@
     SoilDataUpdateDepthIntervalMutation,
     SoilDataUpdateMutation,
 )
+from apps.soil_id.graphql.soil_id import soil_id
 
 from .audit_logs import AuditLogNode
 from .commons import TerrasoRelayNode
@@ -141,6 +142,7 @@ class Query(graphene.ObjectType):
     sites = DjangoFilterConnectionField(SiteNode, required=True)
     audit_logs = DjangoFilterConnectionField(AuditLogNode)
     shared_resource = SharedResourceRelayNode.Field()
+    soil_id = soil_id
     from .shared_resources import resolve_shared_resource
 
 

terraso_backend/apps/graphql/schema/schema.graphql

@@ -4,6 +4,8 @@ schema {
 }
 
 type Query {
+  """Soil ID algorithm Queries"""
+  soilId: SoilId!
   group(
     """The ID of the object"""
     id: ID!
@@ -92,6 +94,180 @@ type Query {
   sharedResource(shareUuid: String!): SharedResourceNode
 }
 
+"""Soil ID algorithm queries."""
+type SoilId {
+  locationBasedSoilMatches(latitude: Float!, longitude: Float!): LocationBasedSoilMatches!
+  dataBasedSoilMatches(latitude: Float!, longitude: Float!, data: SoilIdInputData!): DataBasedSoilMatches!
+}
+
+"""A ranked group of soil matches based solely on a coordinate pair."""
+type LocationBasedSoilMatches {
+  matches: [LocationBasedSoilMatch!]!
+}
+
+"""A soil match based solely on a coordinate pair."""
+type LocationBasedSoilMatch {
+  dataSource: String!
+  distanceToNearestMapUnitM: Float!
+  soilInfo: SoilInfo!
+  match: SoilMatchInfo!
+}
+
+"""Provides information about soil at a particular location."""
+type SoilInfo {
+  soilSeries: SoilSeries!
+  ecologicalSite: EcologicalSite
+  landCapabilityClass: LandCapabilityClass!
+  soilData: SoilIdSoilData!
+}
+
+"""Information about a soil series."""
+type SoilSeries {
+  name: String!
+  taxonomySubgroup: String!
+  description: String!
+  fullDescriptionUrl: String!
+}
+
+"""Information about an ecological site."""
+type EcologicalSite {
+  name: String!
+  id: String!
+  url: String!
+}
+
+"""Caveat: may want to update these fields to an enum at some point."""
+type LandCapabilityClass {
+  capabilityClass: String!
+  subClass: String!
+}
+
+"""Soil data associated with a soil match output by the soil algorithm."""
+type SoilIdSoilData {
+  slope: Float
+  depthDependentData: [SoilIdDepthDependentData!]!
+}
+
+"""
+Depth dependent soil data associated with a soil match output by the soil algorithm.
+"""
+type SoilIdDepthDependentData {
+  depthInterval: DepthInterval!
+  texture: SoilIdDepthDependentSoilDataTextureChoices
+  rockFragmentVolume: SoilIdDepthDependentSoilDataRockFragmentVolumeChoices
+  colorHue: Float
+  colorValue: Float
+  colorChroma: Float
+}
+
+type DepthInterval {
+  start: Int!
+  end: Int!
+}
+
+"""An enumeration."""
+enum SoilIdDepthDependentSoilDataTextureChoices {
+  """Sand"""
+  SAND
+
+  """Loamy Sand"""
+  LOAMY_SAND
+
+  """Sandy Loam"""
+  SANDY_LOAM
+
+  """Silt Loam"""
+  SILT_LOAM
+
+  """Silt"""
+  SILT
+
+  """Loam"""
+  LOAM
+
+  """Sandy Clay Loam"""
+  SANDY_CLAY_LOAM
+
+  """Silty Clay Loam"""
+  SILTY_CLAY_LOAM
+
+  """Clay Loam"""
+  CLAY_LOAM
+
+  """Sandy Clay"""
+  SANDY_CLAY
+
+  """Silty Clay"""
+  SILTY_CLAY
+
+  """Clay"""
+  CLAY
+}
+
+"""An enumeration."""
+enum SoilIdDepthDependentSoilDataRockFragmentVolumeChoices {
+  """0 — 1%"""
+  VOLUME_0_1
+
+  """1 — 15%"""
+  VOLUME_1_15
+
+  """15 — 35%"""
+  VOLUME_15_35
+
+  """35 — 60%"""
+  VOLUME_35_60
+
+  """> 60%"""
+  VOLUME_60
+}
+
+"""
+The likelihood score and rank within the match group for a particular soil type.
+"""
+type SoilMatchInfo {
+  score: Float!
+  rank: Int!
+}
+
+"""
+A ranked group of soil matches based on a coordinate pair and soil data.
+"""
+type DataBasedSoilMatches {
+  matches: [DataBasedSoilMatch!]!
+}
+
+"""A soil match based on a coordinate pair and soil data."""
+type DataBasedSoilMatch {
+  dataSource: String!
+  distanceToNearestMapUnitM: Float!
+  soilInfo: SoilInfo!
+  locationMatch: SoilMatchInfo!
+  dataMatch: SoilMatchInfo!
+  combinedMatch: SoilMatchInfo!
+}
+
+"""Soil data provided to the soil ID algorithm."""
+input SoilIdInputData {
+  slope: Float
+  depthDependentData: [SoilIdInputDepthDependentData!]!
+}
+
+"""Depth dependent data provided to the soil ID algorithm."""
+input SoilIdInputDepthDependentData {
+  depthInterval: DepthIntervalInput!
+  texture: SoilIdDepthDependentSoilDataTextureChoices = null
+  rockFragmentVolume: SoilIdDepthDependentSoilDataRockFragmentVolumeChoices = null
+  colorHue: Float
+  colorValue: Float
+  colorChroma: Float
+}
+
+input DepthIntervalInput {
+  start: Int!
+  end: Int!
+}
+
 type GroupNode implements Node {
   slug: String!
   name: String!
@@ -1119,11 +1295,6 @@ type SoilDataDepthIntervalNode {
   depthInterval: DepthInterval!
 }
 
-type DepthInterval {
-  start: Int!
-  end: Int!
-}
-
 type DepthDependentSoilDataNode {
   texture: SoilIdDepthDependentSoilDataTextureChoices
   clayPercent: Int
@@ -1151,63 +1322,6 @@ type DepthDependentSoilDataNode {
   depthInterval: DepthInterval!
 }
 
-"""An enumeration."""
-enum SoilIdDepthDependentSoilDataTextureChoices {
-  """Sand"""
-  SAND
-
-  """Loamy Sand"""
-  LOAMY_SAND
-
-  """Sandy Loam"""
-  SANDY_LOAM
-
-  """Silt Loam"""
-  SILT_LOAM
-
-  """Silt"""
-  SILT
-
-  """Loam"""
-  LOAM
-
-  """Sandy Clay Loam"""
-  SANDY_CLAY_LOAM
-
-  """Silty Clay Loam"""
-  SILTY_CLAY_LOAM
-
-  """Clay Loam"""
-  CLAY_LOAM
-
-  """Sandy Clay"""
-  SANDY_CLAY
-
-  """Silty Clay"""
-  SILTY_CLAY
-
-  """Clay"""
-  CLAY
-}
-
-"""An enumeration."""
-enum SoilIdDepthDependentSoilDataRockFragmentVolumeChoices {
-  """0 — 1%"""
-  VOLUME_0_1
-
-  """1 — 15%"""
-  VOLUME_1_15
-
-  """15 — 35%"""
-  VOLUME_15_35
-
-  """35 — 60%"""
-  VOLUME_35_60
-
-  """> 60%"""
-  VOLUME_60
-}
-
 """An enumeration."""
 enum SoilIdDepthDependentSoilDataColorPhotoSoilConditionChoices {
   """Moist"""
@@ -2193,11 +2307,6 @@ input DepthDependentSoilDataUpdateMutationInput {
   clientMutationId: String
 }
 
-input DepthIntervalInput {
-  start: Int!
-  end: Int!
-}
-
 type SoilDataUpdateDepthIntervalMutationPayload {
   errors: GenericScalar
   soilData: SoilDataNode