Skip to content

Conversation

@ka-sarthak
Copy link
Collaborator

@ka-sarthak ka-sarthak commented May 30, 2024

This brings the following changes in the schema

  • Refactors around sample

    • Sample is a composite system containing information about the sample id, geometry, and reference to the material system under components sub-section.
    • TransmissionSampleReference is a composite system reference containing information related to the sample that is specific to the Transmission. It has a reference to Sample, thickness or path length, and orientation of the sample with respect to the light beam. Path length can be taken from the sample geometry. Orientation is expected to be in miller indices.
    • Adds calculation for extinction coefficient based on the path length
    • Modifies merge_section utils to allow overwriting of the quantities. If something is entered in the ELN, it takes priority over pre-filled data. This feature isn't used yet, but available to future.
  • Adds the tests for backward compatibility

  • Moves RawFileTransmissionData to schema.py

  • Renames the classes for consistency

The material system classes, originally planned to be written here, will be handled in nomad-material-processing FAIRmat-NFDI/nomad-material-processing#77.

@ka-sarthak ka-sarthak self-assigned this May 30, 2024
@ka-sarthak ka-sarthak force-pushed the transmission-modify-sample branch from e3fdf66 to c2c3727 Compare May 31, 2024 11:46
@ka-sarthak ka-sarthak added the breaking changes Changes made with this PR will need manual effort to reconcile with the existing entries label Jun 27, 2024
@ka-sarthak ka-sarthak force-pushed the transmission-modify-sample branch 2 times, most recently from 2ffd519 to ad38e07 Compare July 2, 2024 12:16
@ka-sarthak ka-sarthak force-pushed the transmission-modify-sample branch from 28139b5 to d2789b7 Compare August 21, 2024 11:26
@ka-sarthak ka-sarthak force-pushed the transmission-modify-sample branch from d2789b7 to fc3b634 Compare August 28, 2024 14:34
@ka-sarthak ka-sarthak changed the base branch from main to transmission-new-version August 29, 2024 13:14
@ka-sarthak ka-sarthak force-pushed the transmission-modify-sample branch from 0bf5cb9 to 0d3dba3 Compare August 29, 2024 14:50
@ka-sarthak ka-sarthak force-pushed the transmission-modify-sample branch from 4b6a549 to 7ec62c5 Compare September 10, 2024 14:17
@ka-sarthak ka-sarthak force-pushed the transmission-new-version branch from 4b6a549 to 7879efb Compare September 10, 2024 14:37
@ka-sarthak ka-sarthak force-pushed the transmission-modify-sample branch from 7ec62c5 to 4b6a549 Compare September 10, 2024 14:37
@ka-sarthak ka-sarthak merged commit 8de873b into transmission-new-version Sep 10, 2024
@ka-sarthak ka-sarthak deleted the transmission-modify-sample branch September 10, 2024 14:37
ka-sarthak added a commit that referenced this pull request Oct 2, 2024
* Order quantities; revert modification of basesection quantities

* Modify description of quantities

* Populate elements and components based on chemical_composition

* Add overwrite_quantity in merge_sections

* Include merge section capability to allow GUI interaction in `components`

* Restrict component class to `PureSubstanceComponent`

* Move material system as sub-section in TransmissionSample

* Add module for material_system and classes for Solid Solution

* Create TransmissionSampleReference class and use it in samples subsection

* Make SolidSolution as an entry class; reference it in TransmissionSample

* Bugfix: logic of adjusting composition

* Rearrange imports

* Add physical properties classes

* Refactor Transmission sample to be a section containing reference and physical props; refactor normalize

* Fixing rebase

* Changing warn to warning

* Move Physical properties to schema

* Rename section names; add docstring for naming convention

* Add crystal, polycrystal, mixed crystal, mixed polycrystal sections

* Ruff

* Add material system entry point; rename dopant as impurity

* Refine the ELN properties of sample related schemas

* Refine ELN properties for material system; make atomic percentage in to atomic fraction

* Remove materials_system: they will be moved to nomad-material-processing

* Align TransmissionSampleReference with CompositeSystemReference

* Compose a Sample class based on composite system

* Refactor extinction coefficient calc and plot

* Temporary bugfix for extinction coeff calc; minor changes in schema

* Update nomad

* Bugfix schema import; ignore search when in client context

* Add caplog conftest

* Bugfix: updating schema in search_quantities

* Add aliases

* Add previous archives to test for backward compatibility

* Add test for backward compatibility

* Add fixes for backward compatibility

* Move RawFileTransmissionData to schema
ka-sarthak added a commit that referenced this pull request Oct 10, 2024
* Order quantities; revert modification of basesection quantities

* Modify description of quantities

* Populate elements and components based on chemical_composition

* Add overwrite_quantity in merge_sections

* Include merge section capability to allow GUI interaction in `components`

* Restrict component class to `PureSubstanceComponent`

* Move material system as sub-section in TransmissionSample

* Add module for material_system and classes for Solid Solution

* Create TransmissionSampleReference class and use it in samples subsection

* Make SolidSolution as an entry class; reference it in TransmissionSample

* Bugfix: logic of adjusting composition

* Rearrange imports

* Add physical properties classes

* Refactor Transmission sample to be a section containing reference and physical props; refactor normalize

* Fixing rebase

* Changing warn to warning

* Move Physical properties to schema

* Rename section names; add docstring for naming convention

* Add crystal, polycrystal, mixed crystal, mixed polycrystal sections

* Ruff

* Add material system entry point; rename dopant as impurity

* Refine the ELN properties of sample related schemas

* Refine ELN properties for material system; make atomic percentage in to atomic fraction

* Remove materials_system: they will be moved to nomad-material-processing

* Align TransmissionSampleReference with CompositeSystemReference

* Compose a Sample class based on composite system

* Refactor extinction coefficient calc and plot

* Temporary bugfix for extinction coeff calc; minor changes in schema

* Update nomad

* Bugfix schema import; ignore search when in client context

* Add caplog conftest

* Bugfix: updating schema in search_quantities

* Add aliases

* Add previous archives to test for backward compatibility

* Add test for backward compatibility

* Add fixes for backward compatibility

* Move RawFileTransmissionData to schema
ka-sarthak added a commit that referenced this pull request Oct 10, 2024
* Order quantities; revert modification of basesection quantities

* Modify description of quantities

* Populate elements and components based on chemical_composition

* Add overwrite_quantity in merge_sections

* Include merge section capability to allow GUI interaction in `components`

* Restrict component class to `PureSubstanceComponent`

* Move material system as sub-section in TransmissionSample

* Add module for material_system and classes for Solid Solution

* Create TransmissionSampleReference class and use it in samples subsection

* Make SolidSolution as an entry class; reference it in TransmissionSample

* Bugfix: logic of adjusting composition

* Rearrange imports

* Add physical properties classes

* Refactor Transmission sample to be a section containing reference and physical props; refactor normalize

* Fixing rebase

* Changing warn to warning

* Move Physical properties to schema

* Rename section names; add docstring for naming convention

* Add crystal, polycrystal, mixed crystal, mixed polycrystal sections

* Ruff

* Add material system entry point; rename dopant as impurity

* Refine the ELN properties of sample related schemas

* Refine ELN properties for material system; make atomic percentage in to atomic fraction

* Remove materials_system: they will be moved to nomad-material-processing

* Align TransmissionSampleReference with CompositeSystemReference

* Compose a Sample class based on composite system

* Refactor extinction coefficient calc and plot

* Temporary bugfix for extinction coeff calc; minor changes in schema

* Update nomad

* Bugfix schema import; ignore search when in client context

* Add caplog conftest

* Bugfix: updating schema in search_quantities

* Add aliases

* Add previous archives to test for backward compatibility

* Add test for backward compatibility

* Add fixes for backward compatibility

* Move RawFileTransmissionData to schema
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking changes Changes made with this PR will need manual effort to reconcile with the existing entries

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants