Skip to content

Commit

Permalink
basic structure + todo
Browse files Browse the repository at this point in the history
  • Loading branch information
ltroussellier committed Oct 4, 2024
1 parent 471ce68 commit 0d71efa
Show file tree
Hide file tree
Showing 5 changed files with 146 additions and 0 deletions.
78 changes: 78 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# WGCM Vocabulary
Everything Vocabulary related
xxxDD : datadescriptor with :

* Pydantic model of this DD
* Context for ld part of jsonld
* Term in json with a @context pointing to the context.jsonld

# Directory Structure

_archive/
dataDescriptor/
      institutionDD/ # as example
             _context.jsonld
             _pydantic_model.py
             term1.json
             term2.json
             ...
       otherDD/
             samefilestructure
       ...DD/

src/ # all scripts used to create/fill datadescriptor

license # untouch
readme.md # untouch
todo.md # just to see where i am and what im planning to do

# TODO List :


## DD List

activityDD
experimentDD
reportingIntervalDD
gridLabelDD
sourceDD
variableRootDD
datasetVariantDD
directoryDateDD
datasetEditionDD
brandingSuffixDD
archiveDD
hostCollectionDD
standardNameDD
dataNodeDD
datasetGroupDD
sourceInstitutionDD
nominal- ResolutionDD (nominalResolutionDD)
productTypeDD
realmDD
dataRegionDD
sourceTypeDD
varGroupingCDD
datasetStatusDD
inCollectionsDD
temporalLabelDD
verticalLabelDD
horizontalLabelDD
areaLabelDD
realizationDD
initializationDD
physicsDD
forcingDD
dataConventionsDD
dateCreatedDD**
uniqueFileidDD
variableTableDD
longNameDD
varDefQualifierDD
datasetSpecsDD
gridTypeDD
longInstitutionDD

## Choose DD
### find relevant Ontology to describe each attribute of each DD
### Define each => Pydantic model
26 changes: 26 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
[project]
name = "mip-cmor-tables"
version = "0.1.0"
description = "Add your description here"
authors = [
{ name = "TROUSSELLIER Laurent", email = "[email protected]" }
]
dependencies = [
"pyld>=2.0.4",
]
readme = "README.md"
requires-python = ">= 3.8"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.rye]
managed = true
dev-dependencies = []

[tool.hatch.metadata]
allow-direct-references = true

[tool.hatch.build.targets.wheel]
packages = ["src/mip_cmor_tables"]
20 changes: 20 additions & 0 deletions requirements-dev.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# generated by rye
# use `rye lock` or `rye sync` to update this lockfile
#
# last locked with the following flags:
# pre: false
# features: []
# all-features: false
# with-sources: false
# generate-hashes: false
# universal: false

-e file:.
cachetools==5.5.0
# via pyld
frozendict==2.4.4
# via pyld
lxml==5.3.0
# via pyld
pyld==2.0.4
# via mip-cmor-tables
20 changes: 20 additions & 0 deletions requirements.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# generated by rye
# use `rye lock` or `rye sync` to update this lockfile
#
# last locked with the following flags:
# pre: false
# features: []
# all-features: false
# with-sources: false
# generate-hashes: false
# universal: false

-e file:.
cachetools==5.5.0
# via pyld
frozendict==2.4.4
# via pyld
lxml==5.3.0
# via pyld
pyld==2.0.4
# via mip-cmor-tables
2 changes: 2 additions & 0 deletions src/mip_cmor_tables/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
def hello() -> str:
return "Hello from mip-cmor-tables!"

0 comments on commit 0d71efa

Please sign in to comment.