Skip to content

Commit a7c25b0

Browse files
authored
Rename to CDSG for template guide (#48)
ref #43 'Imageomics-guide' to 'Collaborative-distributed-science-guide' in URLs and descriptions
1 parent 04f3a83 commit a7c25b0

13 files changed

+26
-26
lines changed

CITATION.cff

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ date-released: "2024-11-DD"
2020
identifiers:
2121
- description: "The GitHub release URL of tag v1.0.0."
2222
type: url
23-
value: "https://github.com/Imageomics/Imageomics-guide/releases/tag/v1.0.0"
23+
value: "https://github.com/Imageomics/Collaborative-distributed-science-guide/releases/tag/v1.0.0"
2424
- description: "The GitHub URL of the commit tagged with <tag-name>." # update post release
2525
type: url
26-
value: "https://github.com/Imageomics/Imageomics-guide/tree/<commit-hash>" # update post release
26+
value: "https://github.com/Imageomics/Collaborative-distributed-science-guide/tree/<commit-hash>" # update post release
2727
keywords:
2828
- imageomics
2929
- metadata
@@ -37,6 +37,6 @@ keywords:
3737
- standards
3838
license: CC0-1.0
3939
message: "If you find these docs helpful in your research, please cite them as below."
40-
repository-code: "https://github.com/Imageomics/Imageomics-guide"
40+
repository-code: "https://github.com/Imageomics/Collaborative-distributed-science-guide"
4141
title: "Imageomics Guide"
4242
version: "1.0.0"

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# Imageomics Guide
1+
# Collaborative Distributed Science Guide
22

3-
Welcome to the Imageomics Guide!
3+
Welcome to the Collaborative Distributed Science Guide!
44

55
Just joining or starting a new project?
6-
Checkout the [Imageomics Guide](https://imageomics.github.io/Imageomics-guide/) for guidance on conventions and best practices.
6+
Checkout the [Collaborative Distributed Science Guide](https://imageomics.github.io/Collaborative-distributed-science-guide/) for guidance on conventions and best practices.
77

88
## About the Guide
99

10-
This guide started as an Institute-internal wiki, focused on providing guidance and best practices for collaborative and interdisciplinary (computer science + biology) work. Recognizing that the topics and suggestions are broadly applicable to anyone working in similar or adjacent fields, we moved the vast majority to this [guide](https://imageomics.github.io/Imageomics-guide/). To increase accessibility for those less familiar with GitHub, we generated the [web site](https://imageomics.github.io/Imageomics-guide/) from our Markdown documents (which used to be wiki pages) with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
10+
This guide started as an Institute-internal wiki, focused on providing guidance and best practices for collaborative and interdisciplinary (computer science + biology) work. Recognizing that the topics and suggestions are broadly applicable to anyone working in similar or adjacent fields, we moved the vast majority to this [guide](https://imageomics.github.io/Collaborative-distributed-science-guide/). To increase accessibility for those less familiar with GitHub, we generated the web site from our Markdown documents (which used to be wiki pages) with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
1111

12-
Please feel free to open an [issue](https://github.com/Imageomics/Imageomics-guide/issues) with any questions regarding the content fo this guide or if you would like to contribute to the [Glossary](https://imageomics.github.io/Imageomics-guide/wiki-guide/Glossary-for-Imageomics/) or [Helpful Tools page](https://imageomics.github.io/Imageomics-guide/wiki-guide/Helpful-Tools-for-your-Workflow/).
12+
Please feel free to open an [issue](https://github.com/Imageomics/Collaborative-distributed-science-guide/issues) with any questions regarding the content of this guide.
1313

1414
### Testing
1515
To test this site locally, first clone this repository, then create an environment with `requirements.txt`
@@ -20,4 +20,4 @@ and run `mkdocs serve`:
2020
```
2121
mkdocs serve
2222
```
23-
Then the site will run at http://127.0.0.1:8000/Imageomics-guide/.
23+
Then the site will run at http://127.0.0.1:8000/Collaborative-distributed-science-guide/.

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Welcome to the Imageomics Institute Guide!
1+
# Welcome to the Collaborative Distributed Science Guide!
22

33
This website hosts guides to Imageomics workflows, documentation, and general best-practices for collaborative science. We aim to provide a helpful resource for a broad base of scientists working in the field of [_imageomics_](wiki-guide/Glossary-for-Imageomics.md/#imageomics) and beyond.
44

@@ -68,4 +68,4 @@ We have two versions of the logo, a [fish](logos/Imageomics_logo_fish.png) and a
6868
<br>
6969
<br>
7070

71-
!!! question "[Questions, Comments, or Concerns?](https://github.com/Imageomics/Imageomics-guide/issues)"
71+
!!! question "[Questions, Comments, or Concerns?](https://github.com/Imageomics/Collaborative-distributed-science-guide/issues)"

docs/wiki-guide/Code-Checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,4 +104,4 @@ The [Repo Guide](GitHub-Repo-Guide.md/) provides general guidance on repository
104104
- [ ] **Packaging**: Provide installation instructions (e.g., `setup.py`, `hatch`, `poetry`, `uv` for Python).
105105
- [ ] **Deployment Guide**: Document deployment procedures
106106

107-
!!! question "[Questions, Comments, or Concerns?](https://github.com/Imageomics/Imageomics-guide/issues)"
107+
!!! question "[Questions, Comments, or Concerns?](https://github.com/Imageomics/Collaborative-distributed-science-guide/issues)"

docs/wiki-guide/DOI-Generation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,4 @@ When creating a new record on Zenodo, please ensure that other members of your p
7171

7272
[Dryad](https://datadryad.org/stash/about) is another research data repository, similar to Zenodo, through which one can archive digital objects (such as, but not limited to, data) supporting scholarly publications, and obtain a DOI. It has a review process when depositing data and requires dedication to the public domain (CC0) of all digital objects uploaded. Imageomics through OSU is a member organization of Dryad, reducing or eliminating data deposit charge(s). To determine whether Dryad is a suitable archive for Institute data products supporting your publication, please consider the [Data Archive Options Comparative Overview](../pdfs/Data_Archive-Publication-Options-Comparative-Overview.pdf) for more information, and consult with the Institute's Senior Data Scientist.[^1]
7373

74-
!!! question "[Questions, Comments, or Concerns?](https://github.com/Imageomics/Imageomics-guide/issues)"
74+
!!! question "[Questions, Comments, or Concerns?](https://github.com/Imageomics/Collaborative-distributed-science-guide/issues)"

docs/wiki-guide/Data-Checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,4 @@ See discussion and references in the [template](HF_DatasetCard_Template_mkdocs.m
107107

108108
- [ ] **Contact Information**: [OPTIONAL] We recommend people use HF discussions, but you may indicate a person to contact.
109109

110-
!!! question "[Questions, Comments, or Concerns?](https://github.com/Imageomics/Imageomics-guide/issues)"
110+
!!! question "[Questions, Comments, or Concerns?](https://github.com/Imageomics/Collaborative-distributed-science-guide/issues)"

docs/wiki-guide/FAIR-Guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The last topic in this section discusses different methods of [DOI Generation](D
2626
- The [FARR Research Coordination Network](https://www.farr-rcn.org/) has a number of interesting resources and events.
2727
- The [Research Data Aliance for Interdisciplinary Research](https://www.rd-alliance.org/disciplines/rda-for-interdisciplinary-research/) also provides links to resources and events particularly focused on considerations in interdisciplinary research.
2828

29-
!!! question "[Questions, Comments, or Concerns?](https://github.com/Imageomics/Imageomics-guide/issues)"
29+
!!! question "[Questions, Comments, or Concerns?](https://github.com/Imageomics/Collaborative-distributed-science-guide/issues)"
3030

3131
[^1]: While "Reproducible" is not part of the original FAIR principles as defined by the [Go-FAIR Initiative](https://www.go-fair.org/fair-principles/), we include it here to emphasize the importance of computational reproducibility alongside data stewardship. This extension reflects emerging practice in data-intensive science, where code, models, and workflows must be reusable and verifiable to support robust scientific claims. It is not part of the formal FAIR acronym, but aligns with broader community goals for open and transparent research.
3232
[^2]: Full reproducibility is difficult to achieve; this [presentation](https://drive.google.com/file/d/1BFqZ00zMuyVHaD9A8PvzRDEg7aV0kp3W/view?usp=drive_link) by Odd Erik Gundersen provides a discussion of the varying degrees of reproducibilityand useful references when considering the level of reproducibility achieved by a given project.

docs/wiki-guide/HF_DatasetCard_Template_mkdocs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Below are the Dataset Card templates for Imageomics and ABC. You can download or
55
<details>
66
<summary>Imageomics</summary>
77
</br>
8-
<b><a href="https://github.com/Imageomics/Imageomics-guide/blob/main/docs/wiki-guide/HF_DatasetCard_Template_Imageomics.md" target="_blank">Download template from GitHub</a></b>
8+
<b><a href="https://github.com/Imageomics/Collaborative-distributed-science-guide/blob/main/docs/wiki-guide/HF_DatasetCard_Template_Imageomics.md" target="_blank">Download template from GitHub</a></b>
99

1010
{{ include_file_as_code("docs/wiki-guide/HF_DatasetCard_Template_Imageomics.md") }}
1111

@@ -14,7 +14,7 @@ Below are the Dataset Card templates for Imageomics and ABC. You can download or
1414
<details>
1515
<summary>ABC</summary>
1616
</br>
17-
<b><a href="https://github.com/Imageomics/Imageomics-guide/blob/main/docs/wiki-guide/HF_DatasetCard_Template_ABC.md" target="_blank">Download template from GitHub</a></b>
17+
<b><a href="https://github.com/Imageomics/Collaborative-distributed-science-guide/blob/main/docs/wiki-guide/HF_DatasetCard_Template_ABC.md" target="_blank">Download template from GitHub</a></b>
1818

1919
{{ include_file_as_code("docs/wiki-guide/HF_DatasetCard_Template_ABC.md") }}
2020

docs/wiki-guide/HF_ModelCard_Template_mkdocs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Below are the Model Card templates for Imageomics and ABC. You can download or c
55
<details>
66
<summary>Imageomics</summary>
77
</br>
8-
<b><a href="https://github.com/Imageomics/Imageomics-guide/blob/main/docs/wiki-guide/HF_ModelCard_Template_Imageomics.md" target="_blank">Download template from GitHub</a></b>
8+
<b><a href="https://github.com/Imageomics/Collaborative-distributed-science-guide/blob/main/docs/wiki-guide/HF_ModelCard_Template_Imageomics.md" target="_blank">Download template from GitHub</a></b>
99

1010

1111
{{ include_file_as_code("docs/wiki-guide/HF_ModelCard_Template_Imageomics.md") }}
@@ -15,7 +15,7 @@ Below are the Model Card templates for Imageomics and ABC. You can download or c
1515
<details>
1616
<summary>ABC</summary>
1717
</br>
18-
<b><a href="https://github.com/Imageomics/Imageomics-guide/blob/main/docs/wiki-guide/HF_ModelCard_Template_ABC.md" target="_blank">Download template from GitHub</a></b>
18+
<b><a href="https://github.com/Imageomics/Collaborative-distributed-science-guide/blob/main/docs/wiki-guide/HF_ModelCard_Template_ABC.md" target="_blank">Download template from GitHub</a></b>
1919

2020
{{ include_file_as_code("docs/wiki-guide/HF_ModelCard_Template_ABC.md") }}
2121

docs/wiki-guide/Helpful-Tools-for-your-Workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Helpful Tools for your Workflow
22

3-
This page is dedicated to tools that can facilitate or improve project workflows. If there's something you use regularly that you think should be on this list, please [suggest it](https://github.com/Imageomics/Imageomics-guide/issues)!
3+
This page is dedicated to tools that can facilitate or improve project workflows. If there's something you use regularly that you think should be on this list, please [suggest it](https://github.com/Imageomics/Collaborative-distributed-science-guide/issues)!
44

55
## Jupytext
66

0 commit comments

Comments
 (0)