Skip to content

Commit 6145de6

Browse files
committed
Merge branch 'rename' into 'main'
BASALT renaming See merge request MoNET/analysis-api-schema!55
2 parents 9c27789 + 81c45ee commit 6145de6

1,091 files changed

Lines changed: 16117 additions & 15936 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.copier-answers.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ _src_path: gh:linkml/linkml-project-copier
44
add_example: false
55
copyright_year: '2026'
66
email: maia.kapur@pnnl.gov
7-
existing_license_file: ''
7+
existing_license_file: 'LICENSE'
88
full_name: Maia Kapur
99
gh_action_docs_preview: true
1010
gh_action_pypi: false
1111
github_org: mkapur-pnnl
1212
license: MIT
1313
project_description: Data schema for analysis database at EMSL (PNNL).
14-
project_name: analysis-api-schema
15-
project_slug: analysis_api_schema
14+
project_name: basalt-schema
15+
project_slug: basalt_schema
1616

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Contributing to analysis-api-schema
1+
# Contributing to BASALT
22

33
:+1: First of all: Thank you for taking the time to contribute!
44

55
The following is a set of guidelines for contributing to
6-
analysis-api-schema. These guidelines are not strict rules.
6+
BASALT. These guidelines are not strict rules.
77
Use your best judgment, and feel free to propose changes to this document
88
in a pull request.
99

@@ -22,7 +22,7 @@ in a pull request.
2222

2323
## Code of Conduct
2424

25-
The analysis-api-schema team strives to create a
25+
The BASALT team strives to create a
2626
welcoming environment for editors, users and other contributors.
2727
Please carefully read our [Code of Conduct](CODE_OF_CONDUCT.md).
2828

@@ -73,7 +73,7 @@ Please submit a [Pull Request][pulls] to submit a new term for consideration.
7373
- Never work on the main branch, always work on an issue/feature branch
7474
- Core developers can work on branches off origin rather than forks
7575
- Always create a PR on a branch to maximize transparency of what you are doing
76-
- PRs should be reviewed and merged in a timely fashion by the analysis-api-schema technical leads
76+
- PRs should be reviewed and merged in a timely fashion by the BASALT technical leads
7777
- PRs that do not pass GitHub actions should never be merged
7878
- In the case of git conflicts, the contributor should try and resolve the conflict
7979
- If a PR fails a GitHub action check, the contributor should try and resolve the issue in a timely fashion
@@ -115,7 +115,7 @@ Core developers should read the material on the [LinkML site](https://linkml.io/
115115
[about-branches]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches
116116
[about-issues]: https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues
117117
[about-pulls]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
118-
[issues]: https://github.com/mkapur-pnnl/analysis-api-schema/issues/
119-
[pulls]: https://github.com/mkapur-pnnl/analysis-api-schema/pulls/
118+
[issues]: https://github.com/EMSL-Computing/basalt-schema/issues/
119+
[pulls]: https://github.com/EMSL-Computing/basalt-schema/pulls/
120120

121121
We recommend also reading [GitHub Pull Requests: 10 Tips to Know](https://blog.mergify.com/github-pull-requests-10-tips-to-know/)

LICENSE

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,6 @@
1-
The MIT License (MIT)
2-
3-
Copyright (c) 2026 Maia Kapur
4-
5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
11-
12-
The above copyright notice and this permission notice shall be included in
13-
all copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21-
THE SOFTWARE.
1+
Released under the Creative Commons 0 Public Domain Dedication:
2+
https://creativecommons.org/publicdomain/zero/1.0/
3+
4+
This material is free to use, and attribution is always appreciated. Attribution may be as follows:
5+
Authored by Conrad Mearns, Maia Kapur, Montana Smith, Beata Meluch, Aramy Truong, and Yuri E. Corilo at the Pacific Northwest National Laboratory, operated by Battelle for the U.S. Department of Energy.
6+
Please cite the following in your work: (Place Holder Zenodo)

README.md

Lines changed: 63 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,82 @@
1-
# analysis-api-schema
1+
# BASALT
22

3-
LinkML for the EMSL Science Cental MONet Analysis API schemas
3+
**Broad Analytical Schema for Samples and Laboratory Techniques**
4+
5+
[![Schema version](https://img.shields.io/badge/schema-v0.1.0-blue.svg)](src/basalt_schema/schema/basalt_schema.yaml)
6+
[![LinkML](https://img.shields.io/badge/LinkML-schema-blueviolet.svg)](https://linkml.io)
7+
[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org)
8+
[![License: CC0-1.0](https://img.shields.io/badge/license-CC0%201.0-lightgrey.svg)](LICENSE)
9+
[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-informational.svg)](https://EMSL-Computing.github.io/basalt-schema)
10+
11+
LinkML schema for MONet/EMSL scientific data across **biogeochemical**, **biological**, and **environmental** domains. Canonical source of truth for samples, provenance, laboratory activities, and analytical products used by the Analysis API and database models.
12+
13+
Formerly `analysis-api-schema`.
14+
15+
| | |
16+
| --- | --- |
17+
| **Schema version** | `0.1.0` (see `version` in [`basalt_schema.yaml`](src/basalt_schema/schema/basalt_schema.yaml)) |
18+
| **Package** | `basalt_schema` (Python package version follows git tags via uv-dynamic-versioning) |
19+
| **Docs** | https://EMSL-Computing.github.io/basalt-schema |
20+
| **Repository** | https://github.com/EMSL-Computing/basalt-schema |
21+
| **Canonical URI** | https://EMSL-Computing.github.io/basalt-schema |
422

523
## Repository Structure
624

725
* [examples/](examples/) - example data
826
* [project/](project/) - project files (do not edit these)
927
* [src/](src/) - source files (edit these)
10-
* [analysis_api_schema](src/analysis_api_schema)
11-
* [schema](src/analysis_api_schema/schema) -- LinkML schema
12-
* [datamodel](src/analysis_api_schema/datamodel) -- generated
28+
* [basalt_schema](src/basalt_schema)
29+
* [schema](src/basalt_schema/schema) -- LinkML schema
30+
* [datamodel](src/basalt_schema/datamodel) -- generated
1331
* [tests/](tests/) - Python tests
1432
* [util/](util/) - Adhoc LinkML replacement code
1533

16-
## Developer Documentation
34+
## Versioning
35+
36+
BASALT uses **semantic versioning** (`MAJOR.MINOR.PATCH`) for the schema:
37+
38+
| Change type | Bump | Examples |
39+
| --- | --- | --- |
40+
| **MAJOR** | Breaking model changes | Rename/remove classes or required slots; change identifiers; incompatible range changes |
41+
| **MINOR** | Backward-compatible additions | New optional classes/slots/enums; new modules; expanded permissible values |
42+
| **PATCH** | Non-breaking fixes | Description/docs fixes; typo corrections; generator/tooling-only fixes that do not change the model |
43+
44+
### How versions are recorded
45+
46+
1. **Schema version (authoritative for the data model)**
47+
Set in the root schema file:
48+
```yaml
49+
# src/basalt_schema/schema/basalt_schema.yaml
50+
version: 0.1.0
51+
```
1752
18-
Windows and Powershell users:
53+
2. **Python package version**
54+
Derived from **git tags** (`v0.1.0`, `v0.2.0`, …) via [uv-dynamic-versioning](https://github.com/ninoseki/uv-dynamic-versioning).
55+
Installable package name: `basalt_schema`.
56+
57+
3. **Release checklist**
58+
- [ ] Bump `version` in `src/basalt_schema/schema/basalt_schema.yaml`
59+
- [ ] Update the schema version badge / table in this README
60+
- [ ] Regenerate project artifacts if needed (`just gen-project`)
61+
- [ ] Merge to `main`
62+
- [ ] Tag the release: `git tag -a v0.1.0 -m "basalt-schema 0.1.0"` and push tags
63+
- [ ] Consumers pin or track the tag / package version
64+
65+
Consumers (API, DB migrations, ingestion) should record which schema version they were built against.
66+
67+
## Developer Documentation
1968

2069
```bash
2170
uv sync
22-
2371
just gen-project
2472
```
2573

74+
Windows and PowerShell users can use the same commands when `uv` and `just` are installed.
75+
2676
## Credits
2777

28-
This project was made with `LinkML`
78+
This material is free to use, and attribution is always appreciated. Attribution may read as follows:
79+
80+
Authored by Conrad Mearns, Maia Kapur, Montana Smith, Beata Meluch, Aramy Truong, and Yuri E. Corilo at the Pacific Northwest National Laboratory, operated by Battelle for the U.S. Department of Energy.
81+
82+
(Optional, if applicable): Please cite the following in your work: (Place Holder Zenodo)

config.public.mk

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
# Note:
88
# - just works fine with quoted variables of dot-env files like this one
9-
LINKML_SCHEMA_NAME="analysis_api_schema"
9+
LINKML_SCHEMA_NAME="basalt_schema"
1010
LINKML_SCHEMA_AUTHOR="Maia Kapur <maia.kapur@pnnl.gov>"
11-
LINKML_SCHEMA_DESCRIPTION="Data schema for analysis database at EMSL (PNNL)."
12-
LINKML_SCHEMA_SOURCE_DIR="src/analysis_api_schema/schema"
11+
LINKML_SCHEMA_DESCRIPTION="Broad Analytical Schema for Samples and Laboratory Techniques."
12+
LINKML_SCHEMA_SOURCE_DIR="src/basalt_schema/schema"
1313

1414
###### linkml generator variables, used by justfile
1515

disclaimer.txt

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
This material was prepared as an account of work sponsored by an agency of the United States Government.  Neither the United States Government nor the United States Department of Energy, nor the Contractor, nor any or their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.
2+
3+
Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.
4+
5+
 
6+
7+
PACIFIC NORTHWEST NATIONAL LABORATORY
8+
9+
operated by
10+
11+
BATTELLE
12+
13+
for the
14+
15+
UNITED STATES DEPARTMENT OF ENERGY
16+
17+
under Contract DE-AC05-76RL01830

docs/about.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,30 @@
1-
# About
2-
3-
The MONet Analysis API Schema is a [LinkML](https://linkml.io)-based data model for
4-
MONet soil analysis data management. It defines the canonical structures for samples,
5-
processed data products, site metadata, and enrichment providers used in the
6-
MONet Analysis API.
7-
8-
**Repository:** [pnnl/analysis-api](https://github.com/pnnl/analysis-api)
9-
**Canonical URI:** <https://w3id.org/MONet/analysis-api-schema>
10-
**License:** MIT
11-
12-
## Contacts
13-
14-
- Maia Kapur (maia.kapur@pnnl.gov)
15-
- Conrad Mearns (conrad.mearns@pnnl.gov)
16-
- Montana Smith (montana.smith@pnnl.gov)
1+
# About
2+
3+
**BASALT** — Broad Analytical Schema for Samples and Laboratory Techniques
4+
5+
The BASALT schema is a [LinkML](https://linkml.io)-based data model for MONet/EMSL scientific data across biogeochemical, biological, and environmental domains. It defines canonical structures for samples, provenance, laboratory activities, analytical products, site metadata, and related entities used by BASALT consumers (Analysis API, database models, and tooling).
6+
7+
| | |
8+
| --- | --- |
9+
| **Schema version** | `0.1.0` |
10+
| **Repository** | https://github.com/EMSL-Computing/basalt-schema |
11+
| **Docs** | https://EMSL-Computing.github.io/basalt-schema |
12+
| **Canonical URI** | https://EMSL-Computing.github.io/basalt-schema |
13+
| **License** | [CC0 1.0 Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/) |
14+
15+
Schema version is declared in the root LinkML file (`src/basalt_schema/schema/basalt_schema.yaml`) and follows semantic versioning. See the repository README for the release process.
16+
17+
## Contacts
18+
19+
- Yuri Corilo (corilo@pnnl.gov)
20+
- Maia Kapur (maia.kapur@pnnl.gov)
21+
- Bea Meluch (beata.meluch@pnnl.gov)
22+
- Montana Smith (montana.smith@pnnl.gov)
23+
24+
## Credits
25+
26+
This material is free to use, and attribution is always appreciated. Attribution may read as follows:
27+
28+
Authored by Conrad Mearns, Maia Kapur, Montana Smith, Beata Meluch, Aramy Truong, and Yuri E. Corilo at the Pacific Northwest National Laboratory, operated by Battelle for the U.S. Department of Energy.
29+
30+
(Optional, if applicable): Please cite the following in your work: (Place Holder Zenodo)

docs/analysis-api-schema.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/background/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Background
22

3-
Overview material for the analysis API schema.
3+
Overview material for the BASALT Schema.
44

55
Use this section for context, design rationale, and project history that supports the schema reference.

0 commit comments

Comments
 (0)