Skip to content

Commit

Permalink
Deleted fields specifying relative paths
Browse files Browse the repository at this point in the history
  • Loading branch information
@Andros-Spica
Andros-Spica committed Dec 2, 2022
1 parent 333591a commit bfe3f89
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 40 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
- V 0.4.0: Assuming now that subdirectory names and default files (README.md, references.bib) are fixed, so deleted the following fields: bibFile, codeDir, readmeFile, docsDir.
- V 0.3.0: Made the softwareDependencies field specific to each implementation. Added the Keywords section with modelling and programming lists. Added table of contents.
- V 0.2.0: Moved documentation on implementation to inside the implementation directory. In NASSA.yml: specify in 'docsDir' description that it refers to the directory name of both the general and the implementation-specific documentation directories; discarded 'designDetailsFile' field.

Expand Down
4 changes: 0 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,6 @@ YYYY-SURNAME-001 (module root)
| description | 0 | | Description of what the module does. It should expand the information already given in the name/title. | String | free text | true |
| relatedModules | 0 | | List of modules this one is related to (similar, depending on, ...) | Array | a valid module id as defined above | false |
| references | 0 | | Literature references | | | false |
| bibFile | 1 | references | Relative path to a .bib file | String | path | true |
| moduleReferences | 1 | references | References that describe and explain the module, any of its parts, or its original use in a model. This includes public repositories holding models that include the module. | Array | a valid citation key from the submission BIBTEX file (.bib) | false |
| useExampleReferences | 1 | references | References citing, describing, or using the module, after it has been published in the NASSA library. | Array | a valid citation key from the submission BIBTEX file (.bib) | false |
| domainKeywords | 0 | | Domain-related keywords | | | false |
Expand All @@ -151,7 +150,6 @@ YYYY-SURNAME-001 (module root)
| programmingKeywords | 0 | | Programming-related keyword(s). Using NASSA schema specifications. | Array | | true |
| implementations | 0 | | List of implementations in different programming languages | | | true |
| language | 1 | implementations | Programming language | String | Options: R, Python, Netlogo, Java, Julia, C#, Ruby, Processing | true |
| codeDir | 1 | implementations | Relative path to the directory containing the implementation in this language | String | path | true |
| softwareDependencies | 1 | implementations | Listing any software (libraries, packages, etc), specifying the release version, on which the module implementation relies to properly function. | Array | free text | true |
| inputs | 0 | | List of inputs required by the module. Create entries for each of the variables that can or should be given/set externally, so that the module can work. | | | false |
| name | 1 | inputs | Parameter/variable/file name in the module. | String | free text | false |
Expand All @@ -164,8 +162,6 @@ YYYY-SURNAME-001 (module root)
| type | 1 | outputs | Variable/object type. Use the programming language specific type. | String | free text | false |
| unit | 1 | outputs | Variable/object unit of measurement, if applicable. | String | free text | false |
| description | 1 | outputs | Variable/object description. Meaning, data structure, or any other relevant information for data analysis and interpretation or the use of the output as input in another module. | String | free text | false |
| readmeFile | 0 | | Relative path to Readme.md or alike, which contains at least the information specified in the NASSA template (<url placeholder>). | String | path | false |
| docsDir | 0 | | Relative path to the directory containing the general documentation resources. The same directory name should be also use inside implementations directories to contain implementation-specific documentation resources (see 'Module file structure' resources. | String | path | false |

(generated with https://kdelmonte.github.io/json-to-markdown-table/)

Expand Down
36 changes: 0 additions & 36 deletions nassa-schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,15 +134,6 @@
"format": "",
"mandatory": false
},
{
"field": "bibFile",
"level": 1,
"parent": "references",
"description": "Relative path to a .bib file",
"type": "String",
"format": "path",
"mandatory": true
},
{
"field": "moduleReferences",
"level": 1,
Expand Down Expand Up @@ -233,15 +224,6 @@
"format": "Options: R, Python, Netlogo, Java, Julia, C#, Ruby, Processing",
"mandatory": true
},
{
"field": "codeDir",
"level": 1,
"parent": "implementations",
"description": "Relative path to the directory containing the implementation in this language",
"type": "String",
"format": "path",
"mandatory": true
},
{
"field": "softwareDependencies",
"level": 1,
Expand Down Expand Up @@ -349,23 +331,5 @@
"type": "String",
"format": "free text",
"mandatory": false
},
{
"field": "readmeFile",
"level": 0,
"parent": "",
"description": "Relative path to Readme.md or alike, which contains at least the information specified in the NASSA template (<url placeholder>).",
"type": "String",
"format": "path",
"mandatory": false
},
{
"field": "docsDir",
"level": 0,
"parent": "",
"description": "Relative path to the directory containing the general documentation resources. The same directory name should be also use inside implementations directories to contain implementation-specific documentation resources (see 'Module file structure'",
"type": "String",
"format": "path",
"mandatory": false
}
]

0 comments on commit bfe3f89

Please sign in to comment.