gov.nasa.pds.model:model-dmdocument

The software tools and data necessary for generating the Information Model including PDS4 ontology, data, and information model.

https://github.com/nasa-pds/pds4-information-model

Science Score: 49.0%

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

  • 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 (15.4%) to scientific vocabulary

Keywords

data-model nasa nasa-pds pds pds4
Last synced: 6 months ago · JSON representation

Repository

The software tools and data necessary for generating the Information Model including PDS4 ontology, data, and information model.

Basic Info
Statistics
  • Stars: 13
  • Watchers: 9
  • Forks: 8
  • Open Issues: 46
  • Releases: 106
Topics
data-model nasa nasa-pds pds pds4
Created over 6 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Codeowners Security Zenodo

README.md

NASA PDS4 Information Model Repo

DOI  Unstable integration & delivery  Stable integration & delivery

The software tools and data necessary for generating the Information Model including PDS4 ontology, data, and information model.

Please visit our website at https://nasa-pds.github.io/pds4-information-model/ for information about the modules that comrpise the information model.

Contributing

Within the NASA Planetary Data System, we value the health of our community as much as the code. Towards that end, we ask that you read and practice what's described in these documents:

  • Our contributor's guide delineates the kinds of contributions we accept.
  • Our code of conduct outlines the standards of behavior we practice and expect by everyone who participates with our software.

Installation

Installation instructions are broken into sections for operational and development installations.

Operational

For operational installation of LDDTool, see the deployed documentation for installation instructions: https://nasa-pds.github.io/pds4-information-model/model-lddtool/install/index.html

Development

For development installation, use maven:

```console $ # Package the software $ mvn clean package

$ # Generate the site (must run package first) $ mvn site:site site:stage

$ # To view generated docs $ open target/staging/model/index.html ```

Testing

Tests are ran using Cucumber and Maven.

Running Tests

```bash

Package the software

mvn clean package

Run Cucumber tests

mvn clean test ```

Adding New Tests

To add additional tests:

  • Create a directory within the resources directory and place your test data there
  • In either the developer or integration feature file, add your test case to the table under Examples. For example,

feature | testName | resourceDirectory | testDirectory | commandArgs | expectedResponse | | "NASA-PDS/pds4-information-model#738 LDDTool is not creating valid URL for KPLO" | "src/test/resources" | "github738" | "-lpJ {resourceDirectory}/{testDirectory}/PDS4_KPLO_IngestLDD.xml" | "0 error(s)" |

Update For New IM Version

See https://github.com/NASA-PDS/pds4-information-model/tree/main/bin#update-for-new-im

Update Site Documentation

To update the site documentation, see each components src/site directory (this is common for all Java Maven software): | Component | Site Directory | Online Documentation | |-----------|----------------|----------------------| | Top-level Page | src/site | https://nasa-pds.github.io/pds4-information-model/ | | LDDTool | model-lddtool/src/site | https://nasa-pds.github.io/pds4-information-model/model-lddtool/ | | DMDocument | model-dmdocument/src/site | https://nasa-pds.github.io/pds4-information-model/model-dmdocument/ | | Ontology | model-ontology/src/site | https://nasa-pds.github.io/pds4-information-model/model-ontology/ |

Detect Secrets

The Planetary Data System's Engineering Node uses detect-secrets, specifically a version forked by the SLIM Team, called slim-detect-secrets. This tool replaces Git Secrets but serves the same purpose: it helps prevent committing information to a repository that should remain secret. Unlike Git Secrets, though, the kinds of secrets detect-secrets finds includes not just passwords or API keys, but also hostnames and email addresses. It also uses entropy analysis to detect randomized strings that could be passwords.

To install, see the wiki. To update a new .secrets.baseline file, run the custom script in the repo to generate the secrets. https://github.com/NASA-PDS/pds4-information-model/tree/main/bin. This is needed because there are numerous additional files that should be ignored in this repo.

Usage

See the deployed documentation for usage details for the various components: https://nasa-pds.github.io/pds4-information-model/

Contributing

Please see the contribution guidelines but also be sure to see our code of conduct.

Versioning

We use the SemVer philosophy for versioning this software.

License

The project is licensed under the Apache version 2 license.

Owner

  • Name: NASA Planetary Data System Software
  • Login: NASA-PDS
  • Kind: organization
  • Email: pds-operator@jpl.nasa.gov

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 213
  • Total pull requests: 163
  • Average time to close issues: 3 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 22
  • Total pull request authors: 9
  • Average comments per issue: 2.23
  • Average comments per pull request: 1.32
  • Merged pull requests: 134
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 72
  • Pull requests: 87
  • Average time to close issues: 21 days
  • Average time to close pull requests: 3 days
  • Issue authors: 12
  • Pull request authors: 6
  • Average comments per issue: 1.38
  • Average comments per pull request: 1.92
  • Merged pull requests: 65
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jordanpadams (120)
  • jshughes (70)
  • c-suh (11)
  • rsjoyner (6)
  • rgdeen (3)
  • plawton-umd (3)
  • msbentley (3)
  • murashinln (2)
  • cgobat (2)
  • acraugh (2)
  • jmafi (2)
  • tdddblog (2)
  • tcornet (2)
  • jstone-psi (1)
  • mace-space (1)
Pull Request Authors
  • jshughes (150)
  • jordanpadams (38)
  • rsjoyner (7)
  • rchenatjpl (4)
  • nutjob4life (3)
  • miguelp1986 (3)
  • dependabot[bot] (3)
  • al-niessner (2)
  • jstone-psi (1)
  • tloubrieu-jpl (1)
  • jshughes416 (1)
Top Labels
Issue Labels
i&t.skip (109) sprint-backlog (68) bug (57) task (56) p.must-have (53) requirement (52) B15.0 (43) pending-scr (38) B15.1 (33) theme (33) enhancement (33) Epic (32) B13.1 (30) B14.1 (28) needs:triage (22) B14.0 (22) s.medium (19) i&t.done (18) B12.1 (17) B16 (16) s.high (15) icebox (15) p.should-have (12) B13.0 (7) s.critical (6) p.could-have (5) i&t.issue (4) needs:dependency (4) open.15.2.3 (2) s.low (2)
Pull Request Labels
B15.0 (11) B15.1 (5) dependencies (3) java (3) sprint-backlog (2) lddtool (2) task (2) i&t.skip (2) product-backlog (1) bug (1) needs:triage (1) B14.1 (1)

Packages

  • Total packages: 4
  • Total downloads: unknown
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 136
repo1.maven.org: gov.nasa.pds.model:model-dmdocument

The Model DM-Document component provides Maven plugins that generate DM documents and other artifacts from ontologies.

  • Versions: 35
  • Dependent Packages: 1
  • Dependent Repositories: 1
Rankings
Dependent repos count: 20.8%
Dependent packages count: 33.0%
Average: 34.3%
Forks count: 39.8%
Stargazers count: 43.5%
Last synced: 6 months ago
repo1.maven.org: gov.nasa.pds.model:model-ontology

The PDS4 Model Ontology component conains the Protégé ontology instances for the PDS4 information and data model, and uses the Maven plugin "model-dmdocument" to generate documentation and other artifcats from the ontology into a generated JAR file.

  • Versions: 35
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Forks count: 27.5%
Stargazers count: 30.3%
Dependent repos count: 32.0%
Average: 34.6%
Dependent packages count: 48.9%
Last synced: 6 months ago
repo1.maven.org: gov.nasa.pds.model:model-lddtool

The PDS4 LDDTool uses the Maven plugin "model-dmdocument" as an executible jar to process an input XML file. The input XML document is parsed and the contents are validated against the master database. The validated contents are integrated into the master database. The XML Schema and Schematron files are written. The process report and spreadsheet are written.

  • Versions: 35
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Forks count: 27.5%
Stargazers count: 30.3%
Dependent repos count: 32.0%
Average: 34.6%
Dependent packages count: 48.9%
Last synced: 6 months ago
repo1.maven.org: gov.nasa.pds:model

The PDS4 Information Model package describes the information model in use by PDS4.

  • Versions: 31
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 32.0%
Average: 40.4%
Dependent packages count: 48.9%
Last synced: 6 months ago

Dependencies

model-dmdocument/pom.xml maven
  • org.apache.maven.plugin-tools:maven-plugin-annotations 3.6.1 provided
  • javax.json:javax.json-api 1.1.4
  • javax.servlet:javax.servlet-api 3.1.0
  • net.sourceforge.argparse4j:argparse4j 0.9.0
  • org.apache.maven:maven-plugin-api 3.6.1
  • org.codehaus.plexus:plexus-utils 3.4.0
  • junit:junit 4.13.1 test
model-lddtool/pom.xml maven
  • gov.nasa.pds.model:model-dmdocument ${project.version}
  • net.sourceforge.argparse4j:argparse4j 0.9.0
model-termmap/pom.xml maven
  • javax.servlet:javax.servlet-api 3.1.0 provided
  • gov.nasa.pds.model:model-dmdocument ${pom.version}
  • javax:javaee-api 8.0
.github/workflows/branch-cicd.yaml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-java v3 composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/autobuild v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/stable-cicd.yaml actions
  • NASA-PDS/roundup-action stable composite
  • actions/cache v3 composite
  • actions/checkout v3 composite
.github/workflows/unstable-cicd.yaml actions
  • NASA-PDS/roundup-action stable composite
  • actions/cache v3 composite
  • actions/checkout v3 composite
model-ontology/pom.xml maven
pom.xml maven
.github/workflows/secrets-detection.yaml actions
  • actions/checkout v4 composite