Skip to content

Commit

Permalink
rename Model_Submission, (uncapitalize)
Browse files Browse the repository at this point in the history
  • Loading branch information
dansand committed May 3, 2024
1 parent 2c6ac24 commit ad9bce3
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/model_request_update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ body:
value: |
Thanks for submitting a new model to the M@TE collection.
This information provided in this form will enable us to produce a metadata file for your model, and showcase the model on our website.
The [README.md](https://github.com/ModelAtlasofTheEarth/Model_Submission/blob/main/README.md) file in this repository provides an overview of the remaining model subission steps.
The [README.md](https://github.com/ModelAtlasofTheEarth/model_submission/blob/main/README.md) file in this repository provides an overview of the remaining model subission steps.
Once you click submit, Github actions will parse this form, collect existing metadata, and produce a summary report for your model.
You can maintain a conversation with the M@TE team via the issue thread.
Expand Down
2 changes: 1 addition & 1 deletion .github/scripts/generate_identifier.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def choice(name):
# Get issue
auth = Auth.Token(token)
g = Github(auth=auth)
repo = g.get_repo("ModelAtlasofTheEarth/Model_Submission")
repo = g.get_repo("ModelAtlasofTheEarth/model_submission")
issue = repo.get_issue(number = issue_number)

# Parse issue body
Expand Down
2 changes: 1 addition & 1 deletion .github/scripts/write_repo_contents.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
# Get issue
auth = Auth.Token(token)
g = Github(auth=auth)
repo = g.get_repo("ModelAtlasofTheEarth/Model_Submission")
repo = g.get_repo("ModelAtlasofTheEarth/model_submission")
issue = repo.get_issue(number = issue_number)

# Get model repo
Expand Down
4 changes: 2 additions & 2 deletions .github/scripts/write_report.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# Get issue
auth = Auth.Token(token)
g = Github(auth=auth)
repo = g.get_repo("ModelAtlasofTheEarth/Model_Submission")
repo = g.get_repo("ModelAtlasofTheEarth/model_submission")
issue = repo.get_issue(number = issue_number)
if comment_id:
comment = issue.get_comment(id = comment_id)
Expand All @@ -29,7 +29,7 @@
* Please check the report below, including the Errors and Warnings section \n
* You can update any information, by editing the markdown file at the top of the issue \n
* these edits will trigger the report will be regenerated \n
* once you are satisfied with the results, please add a https://github.com/ModelAtlasofTheEarth/Model_Submission/labels/review%20requested label \n"""
* once you are satisfied with the results, please add a https://github.com/ModelAtlasofTheEarth/model_submission/labels/review%20requested label \n"""

report += f"### Parsed data \n {dict_to_report(data)} \n\n"

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Model submission overview and objectives

* M@TE models begin their life as github repositories, based on a [this repository template](https://github.com/ModelAtlasofTheEarth/mate_model_template)
* New models are spawned using the [github issues functionality](https://github.com/ModelAtlasofTheEarth/Model_Submission/issues), within this repository
* New models are spawned using the [github issues functionality](https://github.com/ModelAtlasofTheEarth/model_submission/issues), within this repository
* We provide workflows (using github actions) that aim to harvest and reuse as much existing metadata as possible, using persistent identifiers such as ORCiDs and RoRs
* The result is a model repository that comes with a rich metadata document, based on the [RO-Crate](https://www.researchobject.org/ro-crate/) project
* This process also assembles material so we can feature the model on the [M@TE website](https://mate.science)
Expand All @@ -12,24 +12,24 @@
## Model submission workflow:

**1) Make a new model request:**
* open a new issue using the [New model request](https://github.com/ModelAtlasofTheEarth/Model_Submission/issues/new/choose)
* open a new issue using the [New model request](https://github.com/ModelAtlasofTheEarth/model_submission/issues/new/choose)
* fill in as much information as you can and submit the issue
* a https://github.com/ModelAtlasofTheEarth/Model_Submission/labels/new%20model label will appear on the original issue
* a https://github.com/ModelAtlasofTheEarth/model_submission/labels/new%20model label will appear on the original issue
* This will trigger workflows that collect this information and source additional metadata relavant to your model
* You will see a summary report for your model, including potential missing information or errors (e.g. URLs that didn't resolve)
* If you have requested the content of your model to be embargoed, you should see an https://github.com/ModelAtlasofTheEarth/Model_Submission/labels/embargo%20requested label. We can still create a model, metadata, and DOI for this model
* If you have requested the content of your model to be embargoed, you should see an https://github.com/ModelAtlasofTheEarth/model_submission/labels/embargo%20requested label. We can still create a model, metadata, and DOI for this model


**2) Editing and review:**

* By editing the first comment in the issue discussion, you will trigger a rebuild of the model information
* When you are satisfied with the information contained in the report, add a https://github.com/ModelAtlasofTheEarth/Model_Submission/labels/review%20requested label to the issue
* When you are satisfied with the information contained in the report, add a https://github.com/ModelAtlasofTheEarth/model_submission/labels/review%20requested label to the issue

**3) Model repository creation:**
* The [model_reviewers](https://github.com/orgs/ModelAtlasofTheEarth/teams/model_reviewers) team will add an https://github.com/ModelAtlasofTheEarth/Model_Submission/labels/model%20approved label to the issue
* The [model_reviewers](https://github.com/orgs/ModelAtlasofTheEarth/teams/model_reviewers) team will add an https://github.com/ModelAtlasofTheEarth/model_submission/labels/model%20approved label to the issue
* this triggers the creation of a new model repository within the M@TE organization, based on [this simple template](https://github.com/ModelAtlasofTheEarth/mate_model_template)
* the model metadata is stored as an [RO-Crate](https://www.researchobject.org/ro-crate/) (named `ro-crate-metadata.json`) in the top level of the repository
* A https://github.com/ModelAtlasofTheEarth/Model_Submission/labels/model%20created label will appear on your issue
* A https://github.com/ModelAtlasofTheEarth/model_submission/labels/model%20created label will appear on your issue
* The github account holder who submitted the model will have owner privillages.


Expand All @@ -41,15 +41,15 @@
* Push any changes back to the [M@TE organization](https://github.com/ModelAtlasofTheEarth/).

**5) Upload model to our [NCI](https://nci.org.au/) Server:**
* Add an https://github.com/ModelAtlasofTheEarth/Model_Submission/labels/upload%20to%20NCI label to the model submission issue
* Add an https://github.com/ModelAtlasofTheEarth/model_submission/labels/upload%20to%20NCI label to the model submission issue
* Let us know (via the original issue) if you need to add additional files that exceed Github's limits
* The [model_reviewers](https://github.com/orgs/ModelAtlasofTheEarth/teams/model_reviewers) team will contact you via email to orchestrate this process

**6) Model published:**
* Your model will be published on the NCI [GeoNetworkCatalog](https://geonetwork.nci.org.au/geonetwork/srv/eng/catalog.search#/home)
* It will recieve a DOI and this will be automatically added to your model metadata
* Your model will be featured on the M@TE website
* a https://github.com/ModelAtlasofTheEarth/Model_Submission/labels/model%20published label will appear on the original issue
* a https://github.com/ModelAtlasofTheEarth/model_submission/labels/model%20published label will appear on the original issue

## Links

Expand Down

0 comments on commit ad9bce3

Please sign in to comment.