Data

Tools

Indexes

Applications

Experiments

Open Source Science

nyaml

https://fairmat-nfdi.github.io/nyaml

https://github.com/fairmat-nfdi/nyaml

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (6.2%) to scientific vocabulary

Keywords

area-b nexus nyaml
Last synced: 6 months ago · JSON representation ·

Repository

https://fairmat-nfdi.github.io/nyaml

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 1
  • Open Issues: 11
  • Releases: 16
Topics
area-b nexus nyaml
Created over 2 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation Authors

README.md

Ruff PyPI - Python Version PyPI PytestDOI

nyaml Tool for NeXus

The nyaml tool is a Python package that provides a command line interface for converting NeXus application definitions or base classes from YAML file format into the nxdl.xml file format and vice-versa. The converter can be called by the command nyaml2nxdl.

You can find the full documentation of the tool here

Owner

  • Name: FAIRmat
  • Login: FAIRmat-NFDI
  • Kind: organization
  • Location: Germany

FAIR data infrastructure for condensed-matter physics and the chemical physics of solids

Citation (CITATION.cff) 

cff-version: 1.2.0
title: 'Nyaml: A Python package that converts YAML to NXDL format and vice versa'
message:
  If you use this software, please cite it using the
  metadata from this file.
type: software
version: 0.2.2
authors:
  - given-names: Andrea
    family-names: Albino
    orcid: 'https://orcid.org/0000-0001-9280-7431'
  - given-names: Rubel
    family-names: Mozumder
    orcid: 'https://orcid.org/0009-0007-5926-6646'
  - given-names: Sandor
    family-names: Brockhauser
    orcid: 'https://orcid.org/0000-0002-9700-4803'
  - given-names: Florian
    family-names: Dobener
    orcid: 'https://orcid.org/0000-0003-1987-6224'
  - given-names: Markus
    family-names: Kühbach
    orcid: 'https://orcid.org/0000-0002-7117-5196'
  - given-names: Lukas
    family-names: Pielsticker
    orcid: 'https://orcid.org/0000-0001-9361-8333'
  - given-names: Sherjeel
    family-names: Shabih
    orcid: 'https://orcid.org/0009-0008-6635-4465'

doi: 10.5281/zenodo.13860810
repository-code: 'https://github.com/FAIRmat-NFDI/nyaml'
url: https://doi.org/10.5281/zenodo.13860810
abstract:
  The nyaml converter is a Python software tool designed to transform the NeXus Definition
  Language (NXDL) from YAML format to XML, the official format for NeXus data exchange format
  (https://www.nexusformat.org/), and vice versa. NXDL is used to define experiment instruments,
  setups, or scientific data objects from experiments in a schema-based structure. While the
  official NXDL format is in XML, this tool enables users to write the schema in a more
  developer-friendly YAML format and seamlessly convert it into the official XML format.

  The `nyaml` tool also supports the reverse process, converting XML-based NXDL schemas into
  YAML format. Users can benefit from a more accessible and human-readable way to define
  NeXus data structures, while still adhering to NeXus standards. The tool requires users to
  follow a specific grammar (see full documentation at https://fairmat-nfdi.github.io/nyaml/)
  for embedding NeXus data structures, ensuring compatibility with the XML-based NXDL.

  This work is part of the FAIRmat project (project ID 460197019), funded by the Deutsche
  Forschungsgemeinschaft (DFG, German Research Foundation)
  (https://gepris.dfg.de/gepris/projekt/460197019?language=en). Visit the
  [FAIRmat page](https://www.fairmat-nfdi.eu/fairmat/about-fairmat/consortium-fairmat) for more info.


license: Apache-2.0

GitHub Events

Total
  • Create event: 25
  • Release event: 4
  • Issues event: 23
  • Delete event: 28
  • Issue comment event: 51
  • Push event: 163
  • Pull request review event: 318
  • Pull request review comment event: 328
  • Pull request event: 39
  • Fork event: 1
Last Year
  • Create event: 25
  • Release event: 4
  • Issues event: 23
  • Delete event: 28
  • Issue comment event: 51
  • Push event: 163
  • Pull request review event: 318
  • Pull request review comment event: 328
  • Pull request event: 39
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 14
  • Total pull requests: 23
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 25 days
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 1.36
  • Average comments per pull request: 0.52
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 12
  • Pull requests: 22
  • Average time to close issues: 28 days
  • Average time to close pull requests: 4 days
  • Issue authors: 3
  • Pull request authors: 3
  • Average comments per issue: 1.42
  • Average comments per pull request: 0.5
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • mkuehbach (11)
  • lukaspie (10)
  • RubelMozumder (3)
  • domna (3)
  • sanbrock (1)
Pull Request Authors
  • lukaspie (19)
  • RubelMozumder (12)
  • mkuehbach (5)
  • domna (5)
Top Labels
Issue Labels
bug (3) enhancement (2) good first issue (1)
Pull Request Labels
bug (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,506 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 15
  • Total maintainers: 1
pypi.org: nyaml

A tool to convert yaml NeXus application definitions (nyaml) to nexus definitions language (nxdl).

  • Homepage: https://github.com/FAIRmat-NFDI/nyaml
  • Documentation: https://nyaml.readthedocs.io/
  • License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  • Latest release: 0.2.2
    published 12 months ago
  • Versions: 15
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 1,506 Last month
Rankings
Dependent packages count: 10.1%
Average: 38.7%
Dependent repos count: 67.3%
Maintainers (1)
lukaspie
Last synced: 6 months ago

Dependencies

.github/workflows/publish.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
.github/workflows/pylint.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/pytest.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
dev-requirements.txt pypi
  • astroid ==3.0.1 development
  • black ==23.11.0 development
  • build ==1.0.3 development
  • click ==8.1.7 development
  • dill ==0.3.7 development
  • exceptiongroup ==1.2.0 development
  • iniconfig ==2.0.0 development
  • isort ==5.12.0 development
  • lxml ==4.9.3 development
  • lxml-stubs ==0.4.0 development
  • mccabe ==0.7.0 development
  • mypy ==1.7.1 development
  • mypy-extensions ==1.0.0 development
  • packaging ==23.2 development
  • pathspec ==0.11.2 development
  • pip-tools ==7.3.0 development
  • platformdirs ==4.0.0 development
  • pluggy ==1.3.0 development
  • pycodestyle ==2.11.1 development
  • pylint ==3.0.2 development
  • pyproject-hooks ==1.0.0 development
  • pytest ==7.4.3 development
  • pyyaml ==6.0.1 development
  • tomli ==2.0.1 development
  • tomlkit ==0.12.3 development
  • types-beautifulsoup4 ==4.12.0.7 development
  • types-html5lib ==1.1.11.15 development
  • types-lxml ==2023.10.21 development
  • types-pyyaml ==6.0.12.12 development
  • typing-extensions ==4.8.0 development
  • wheel ==0.42.0 development
pyproject.toml pypi
  • click *
  • lxml *
  • pyyaml *