Skip to content

Commit

Permalink
Merge pull request #1 from Archaeology-ABM/updateTov050
Browse files Browse the repository at this point in the history 
Update to v0.5.0
  • Loading branch information
@Andros-Spica
Andros-Spica authored Feb 21, 2023
2 parents bfe3f89 + d062a9f commit f8c035d
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 10 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
- V 0.5.0: Recovered docsDir field but making the documentation subdirectories not compulsory in file structure. Added more explicit list of programming languages.

- 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.

- V 0.1.0: First schema consolidated, made compatible with nassa-hs and files in NASSA modules so far
27 changes: 19 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The schema for formatting NASSA modules (NASSA.yml fields, directory and file st
- [Minimum (must have, to pass validation)](#minimum-must-have-to-pass-validation)
- [Maximum (can have)](#maximum-can-have)
- [NASSA.yml fields](#nassayml-fields)
- [Programming languages](#programming-languages)
- [NASSA keywords](#nassa-keywords)
- [Modelling keywords](#modelling-keywords)
- [Programming keywords](#programming-keywords)
Expand All @@ -24,15 +25,9 @@ YYYY-SURNAME-001 (module root)
| NASSA.yml
│ README.md
│ references.bib
│
└───documentation
│ │ tableOfContents.md
│
└───<IMPLEMENTATION LANGUAGE>
│ moduleShortTitle.<LANGUAGE EXTENSION>
│
└───documentation
│ tableOfContents.md
└ moduleShortTitle.<LANGUAGE EXTENSION>
```

### Maximum (can have)
Expand Down Expand Up @@ -149,8 +144,9 @@ YYYY-SURNAME-001 (module root)
| modellingKeywords | 0 | | Modelling-related keyword(s). Using NASSA schema specifications. | Array | | true |
| 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 |
| language | 1 | implementations | Programming language | String | Options: 'C#', 'Java', 'Julia', 'NetLogo', 'Processing', 'Python', 'R', 'Ruby'. | 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 |
| docsDir | 0 | | Relative path to the directory containing general module documentation. | String | path | false |
| 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 |
| type | 1 | inputs | Parameter/variable/file type. Use the programming language specific type. | String | free text | false |
Expand All @@ -165,6 +161,21 @@ YYYY-SURNAME-001 (module root)

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

## Programming languages

These are the programming languages currently specified:

| Language name to be used in the NASSA.yml file | Directory name for the respective implementation |
|------------------------------------------------|--------------------------------------------------|
| C# | `csharp_implementation` |
| Java | `java_implementation` |
| Julia | `julia_implementation` |
| NetLogo | `netlogo_implementation` |
| Processing | `processing_implementation` |
| Python | `python_implementation` |
| R | `r_implementation` |
| Ruby | `ruby_implementation` |

## NASSA keywords

### Modelling keywords
Expand Down
13 changes: 11 additions & 2 deletions nassa-schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@
"parent": "implementations",
"description": "Programming language",
"type": "String",
"format": "Options: R, Python, Netlogo, Java, Julia, C#, Ruby, Processing",
"format": "Options: 'C#', 'Java', 'Julia', 'NetLogo', 'Processing', 'Python', 'R', 'Ruby'.",
"mandatory": true
},
{
Expand All @@ -233,6 +233,15 @@
"format": "free text",
"mandatory": true
},
{
"field": "docsDir",
"level": 0,
"parent": "",
"description": "Relative path to the directory containing general module documentation.",
"type": "String",
"format": "path",
"mandatory": false
},
{
"field": "inputs",
"level": 0,
Expand Down Expand Up @@ -332,4 +341,4 @@
"format": "free text",
"mandatory": false
}
]
]

0 comments on commit f8c035d

Please sign in to comment.