Skip to content

season_temp and season for Soil#966

Open
turbomam wants to merge 1 commit intomainfrom
254-update-definition-of-season_temp-mixs0000643
Open

season_temp and season for Soil#966
turbomam wants to merge 1 commit intomainfrom
254-update-definition-of-season_temp-mixs0000643

Conversation

@turbomam
Copy link
Copy Markdown
Member

@turbomam turbomam commented May 20, 2025

  • provides guidance that season_temp shouldn't be filled without season
  • provides examples
  • associates season with Soil
  • replaces dreaded string_serialization on season with an enumeration that serves as documentation and validation

@turbomam turbomam linked an issue May 20, 2025 that may be closed by this pull request
@github-actions
Copy link
Copy Markdown
Contributor

LinkML Linting Results

Summary

Count
Schemas Checked 1
Schemas with Error 1
Schemas with Warning 0
Total Errors 15
Total Warnings 0

Problems per Schema

/home/runner/work/mixs/mixs/src/mixs/schema/mixs.yaml

Errors

  • recommended: Slot 'soil_pH' does not have recommended slot 'description'
  • recommended: Slot 'water_pH' does not have recommended slot 'description'
  • recommended: Subset 'combination_classes' does not have recommended slot 'description'
  • recommended: Subset 'sequencing' does not have recommended slot 'description'
  • recommended: Subset 'environment' does not have recommended slot 'description'
  • recommended: Subset 'nucleic acid sequence source' does not have recommended slot 'description'
  • recommended: Subset 'investigation' does not have recommended slot 'description'
  • standard_naming: Slot has name 'HACCP_term'
  • standard_naming: Slot has name 'IFSAC_category'
  • standard_naming: Slot has name 'air_PM_concen'
  • standard_naming: Slot has name 'ferm_pH'
  • standard_naming: Slot has name 'microb_start_taxID'
  • standard_naming: Slot has name 'soil_pH'
  • standard_naming: Slot has name 'spikein_AMR'
  • standard_naming: Slot has name 'water_pH'

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 20, 2025

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://GenomicsStandardsConsortium.github.io/mixs/pr-preview/pr-966/

Built to branch gh-pages at 2026-03-10 23:42 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Copy link
Copy Markdown
Collaborator

@mslarae13 mslarae13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Good add.

@turbomam turbomam force-pushed the 254-update-definition-of-season_temp-mixs0000643 branch from 0cff8f6 to fa7bd3a Compare March 10, 2026 23:38
Copilot AI review requested due to automatic review settings March 10, 2026 23:38
@github-actions
Copy link
Copy Markdown
Contributor

LinkML Linting Results

Summary

Count
Schemas Checked 1
Schemas with Error 0
Schemas with Warning 0
Total Errors 0
Total Warnings 0

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the MIxS LinkML schema to better document and constrain seasonal metadata for Soil samples, including making season a controlled enumeration and clarifying usage expectations around season_temp.

Changes:

  • Updates the season slot to use SeasonEnum and adjusts its description.
  • Adds guidance to season_temp indicating it should only be populated when season is also populated.
  • Adds season to the Soil extension slots and introduces two new “valid” YAML examples.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
src/mixs/schema/mixs.yaml Switches season to an enum, adds a usage comment to season_temp, and adds season to Soil.
src/data/examples/valid/Soil-alone-season_temp.yaml Adds a Soil example including both season_temp and season (currently not MixsCompliantData-rooted).
src/data/examples/valid/Soil-alone-minimal.yaml Adds a minimal Soil example (currently not MixsCompliantData-rooted).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- al_sat
- al_sat_meth
- misc_param
- season
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Soil now includes the season slot in the schema, but the committed generated Python datamodel (src/mixs/datamodel/mixs.py) still defines Soil without a season field. This leaves the repository in an inconsistent state (schema != generated artifacts) and prevents Python consumers from using the new slot. Regenerate and commit the LinkML-generated artifacts (at least the Python datamodel) after updating the schema.

Suggested change
- season

Copilot uses AI. Check for mistakes.
Comment on lines +1 to +4
samp_name: sample_1
project_name: project_1
depth: 1 m
elev: 100 m
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example file is not shaped like a MixsCompliantData instance (it contains bare Soil slots at the root). The repo’s tests/tools expect valid examples in src/data/examples/valid to be loadable/validatable as MixsCompliantData (e.g., via the soil_data: container slot), so this will likely fail make test/linkml examples and is not covered by tests/test_data.py’s MixsCompliantData*.yaml glob. Wrap the instance under soil_data: - ... (or another appropriate *_soil_data slot) and rename the file to match the existing MixsCompliantData*.yaml convention (or move it to a different directory used for non-root examples).

Suggested change
samp_name: sample_1
project_name: project_1
depth: 1 m
elev: 100 m
soil_data:
- samp_name: sample_1
project_name: project_1
depth: 1 m
elev: 100 m

Copilot uses AI. Check for mistakes.
Comment on lines +1 to +6
samp_name: sample_1
project_name: project_1
depth: 1 m
elev: 100 m
season_temp: 18 degree Celsius
season: winter [NCIT:C94730]
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example file is not shaped like a MixsCompliantData instance (it contains bare Soil slots at the root), which is inconsistent with the other files in src/data/examples/valid and is unlikely to be exercised by the repo’s example validation/test harnesses. Wrap this under soil_data: - ... (or another appropriate *_soil_data slot) and rename to the MixsCompliantData*.yaml convention so it is validated. Also, the filename Soil-alone-season_temp.yaml is misleading because it includes both season_temp and season; consider renaming to reflect that season is present (e.g., ...-season_temp-with-season).

Suggested change
samp_name: sample_1
project_name: project_1
depth: 1 m
elev: 100 m
season_temp: 18 degree Celsius
season: winter [NCIT:C94730]
soil_data:
- samp_name: sample_1
project_name: project_1
depth: 1 m
elev: 100 m
season_temp: 18 degree Celsius
season: winter [NCIT:C94730]

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

update definition of season_temp MIXS:0000643

4 participants