Skip to content

update README and github actions #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 3, 2025
Merged

update README and github actions #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9186dfb
update README
pdowler Oct 31, 2025
4fc3e2b
update checkout action to v3
pdowler Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
steps:

- name: Checkout the repository
uses: actions/checkout@v1
uses: actions/checkout@v3
with:
submodules: true

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/preview.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
steps:

- name: Checkout the repository
uses: actions/checkout@v1
uses: actions/checkout@v3
with:
submodules: true

Expand Down
26 changes: 19 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,32 @@
# CAOM
Common Archive Observation Model
## Common Archive Observation Model

The draft version is CAOM-2.5:
[![PDF-Preview](https://img.shields.io/badge/Preview-PDF-blue)](../../releases/download/auto-pdf-preview/CAOM-draft.pdf)

The version of CAOM in use in the community (not an IVOA standard) is CAOM-2.4:
<a href="http://www.opencadc.org/caom2/">https://www.opencadc.org/caom2/</a>. Previous
non-IVOA standard versions of the VO-DML specification remain in the `src`.

## VO-DML Usage
This module contains a <a href="http://www.ivoa.net/documents/VODML/index.html">VO-DML</a>
description of the CAOM data model and test code to validate the model using the
<a href="https://github.com/opencadc/core/tree/master/cadc-vodml">cadc-vodml</a> tools.
<a href="https://github.com/opencadc/core/tree/master/cadc-vodml">cadc-vodml</a> tools. The model
is currently defined using the VO-DML-1.0 recommendation.

The current released version is CAOM-2.4:
<a href="http://www.opencadc.org/caom2/">http://www.opencadc.org/caom2/</a>
The VO-DML validation requires gradle (6.8 to 8.x). To run the tests locally: `grade test`.

The draft version is CAOM-2.5:
[![PDF-Preview](https://img.shields.io/badge/Preview-PDF-blue)](../../releases/download/auto-pdf-preview/CAOM-draft.pdf)
VO-DML source files are in `src/main/resources`.

## UML Diagrams
UML diagrams are created and maintained manually using
<a href="https://argouml-tigris-org.github.io/tigris/argouml/">ArgoUML</a>.

The UML project file and exported images are in `src/uml`.

## License
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
<img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a>
<br />The Common Archive Observation Model is licensed under the
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
Creative Commons Attribution-ShareAlike 4.0 International License</a>.