Skip to content

Commit 92882f2

Browse files
authored
style: delete extra spaces before multiple new lines (#140)
* style: delete 4 extra spaces before 2 new lines * style: delete 3 extra spaces before 2 new lines * style: delete 2 extra spaces before 2 new lines * style: delete 1 extra spaces before 2 new lines * style: delete 1 extra spaces before 1 new line (yml)
1 parent 60627e8 commit 92882f2

45 files changed

Lines changed: 215 additions & 217 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

user-guide/docs/account-help.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## Password Reset
44

5-
To **reset your password**, go to [https://accounts.tacc.utexas.edu/forgot_password](https://accounts.tacc.utexas.edu/forgot_password){target="_blank"}, enter your username or email address that is associated with your user account, and you will receive an email with a password reset link.
5+
To **reset your password**, go to [https://accounts.tacc.utexas.edu/forgot_password](https://accounts.tacc.utexas.edu/forgot_password){target="_blank"}, enter your username or email address that is associated with your user account, and you will receive an email with a password reset link.
66

77
## Account Reactivation
88

99
If you receive an error message when logging in, and you are confident that you have entered the correct password for your account, then it is likely that you need to **Reactivate Account** as a result of your account being Deactivated due to more than 120 days having passed since you last logged in. You will first need to [request an activation link](https://accounts.tacc.utexas.edu/activate){target="_blank"}. You will then receive an email at the email address associated with your user account that has instructions for account reactivation. It's possible that you won't find this email in your inbox due to your email provider either blocking or marking as spam/junk. If so, send email to helpATdesignsafe-ci.org letting us know you did not receive the email.
1010

11-
Once your account returns to an Active state, you will also need to [pair your MFA App again](https://tacc.utexas.edu/portal/account){target="_blank"}. Note that it is possible your MFA shows as still being paired, and you will need to unpair and then pair again.
11+
Once your account returns to an Active state, you will also need to [pair your MFA App again](https://tacc.utexas.edu/portal/account){target="_blank"}. Note that it is possible your MFA shows as still being paired, and you will need to unpair and then pair again.
1212

1313
## Additional Account Resources
1414

user-guide/docs/analysis/swbatch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ There are two ways of using <code>SWbatch</code>:
2323
<li>Or directly through the DesignSafe-CI Research Workbench.</li>
2424
</ol>
2525

26-
#### Instructions for using the Jupyter Workflow { #start-jupyter }
26+
#### Instructions for using the Jupyter Workflow { #start-jupyter }
2727

2828
<ol>
2929
<li>Visit the <code>SWprepost</code> <a href="https://github.com/jpvantassel/swprepost">GitHub</a> and follow the <code>Getting Started</code> instructions. The advanced example walks you through using the <code>SWinvert</code> surface wave inversion Jupyter workflow. (30 minutes)</li>
@@ -32,7 +32,7 @@ There are two ways of using <code>SWbatch</code>:
3232
<li>Enjoy!</li>
3333
</ol>
3434

35-
#### Instructions for using the DesignSafe-CI Research Workbench { #start-ds }
35+
#### Instructions for using the DesignSafe-CI Research Workbench { #start-ds }
3636

3737
<ol>
3838
<li>Visit the <code>SWprepost</code> <a href="https://github.com/jpvantassel/swprepost">GitHub</a> and follow the <code>Getting Started</code> instructions. This will introduce you to <code>SWprepost</code> and the <code>SWinvert</code> workflow, which is required before proceeding to step 2 in these instructions. (30 minutes)</li>

user-guide/docs/curating/bestpractices.md

Lines changed: 12 additions & 13 deletions
Large diffs are not rendered by default.

user-guide/docs/curating/faq.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@
2121
**A**: We have multiple data models and you may publish project types as "Experimental", "Simulation", "Hybrid Simulation", "Field Research" and "Other". Using the "Field Research" data model, you can publish both Engineering/Geosciences collections as well as Social Sciences collections. Stand-alone reports, presentations, software and white papers, as well as datasets that do not fit with the rest of the project types can be published in the project type "Other".
2222

2323
**Q: How should I select data to be published in a project?**
24-
**A**: While right now there is no limit to the amount of files that can be published in DesignSafe, the comprehension and reuse potential of the data should be important considerations when selecting what data can be published. This goes with the possibility to clearly describe the data and establish and document its completeness and validity. For all project types, you have the option to select a subset of the files uploaded to My Project that you wish to publish without the need to delete them from the Working Directory.
24+
**A**: While right now there is no limit to the amount of files that can be published in DesignSafe, the comprehension and reuse potential of the data should be important considerations when selecting what data can be published. This goes with the possibility to clearly describe the data and establish and document its completeness and validity. For all project types, you have the option to select a subset of the files uploaded to My Project that you wish to publish without the need to delete them from the Working Directory.
2525

2626
**Q: What should I consider before publishing Jupyter Notebooks?**
2727
**A**: Please refer to our Jupyter User Guide document to find information on how to publish a Jupyter Notebook.
2828

2929
### Organizing & Describing Your Dataset { #organizing }
3030

3131
**Q: How should I organize the data files to be published in a project?**
32-
**A**: For each type of project publication, the best way to organize your data is to map them to the organizational schema provided by the data models available for each research type (simulation, experimental, hybrid simulation and field research). These models were designed by experts and represent the main data and documentation components required for others to understand and reuse your dataset.
32+
**A**: For each type of project publication, the best way to organize your data is to map them to the organizational schema provided by the data models available for each research type (simulation, experimental, hybrid simulation and field research). These models were designed by experts and represent the main data and documentation components required for others to understand and reuse your dataset.
3333

3434
**Q: Can I organize my data files into a hierarchy of folders in DesignSafe?**
35-
**A**: DesignSafe offers methods for categorizing (organizing) and tagging (describing) your files. To enhance organization and description of large and complex projects, users can group files in folders. However, it is always best to avoid overly nesting because browsing through an extensive folder hierarchy on the web is slower than on your local computer. So to improve the user experience, you should try to use the smallest number of nested folders necessary. Instead, you may use categories, descriptions, and tags to indicate what the groupings are. This provides a method for users to identify and search your files efficiently.
35+
**A**: DesignSafe offers methods for categorizing (organizing) and tagging (describing) your files. To enhance organization and description of large and complex projects, users can group files in folders. However, it is always best to avoid overly nesting because browsing through an extensive folder hierarchy on the web is slower than on your local computer. So to improve the user experience, you should try to use the smallest number of nested folders necessary. Instead, you may use categories, descriptions, and tags to indicate what the groupings are. This provides a method for users to identify and search your files efficiently.
3636

3737
**Q: How should I describe the dataset organization in a project type "Other"?**
3838
**A**: In project type Other you will be able to tag individual files for ease of data understandability and reuse. If you publish many files and need to organize them in folders, we suggest providing a description of the organizational structure and naming convention that you use in your dataset in a "readme" file or a report. This file can simply be a text file or pdf file.
@@ -44,10 +44,10 @@
4444
**A**: To enhance the knowledge surrounding your dataset, you can use the "Related Work" field at the project level to point to web-pages, publications, or datasets that are published within or outside DesignSafe and that you consider relevant to point to in your publication. For example, you may point to a separate published project in DesignSafe, or provide the title and DOI of an article that relates to your data. You may also use the description fields in the data model to include specific parameters or facts that you want to highlight (e.g. wind speed during a hurricane, earthquake magnitude, damage types, etc.). Adding tags, both from a controlled list available or by including a custom one, helps other users to find the files that they need within the data landing page.
4545

4646
**Q: How can I convey the quality of my data publication?**
47-
**A**: Data quality, as entailed by the metadata, concerns the completeness of the data documentation and the validity and integrity of the data content. Following DesignSafe curation and documentation best practices, as well as the onboarding instructions on the curation and publication interfaces, and adding a data report or data dictionary enables publishing a complete dataset that others will understand. In addition, in the documentation and/or data description, it is important to clarify the processes conducted to assure the completeness and validity of the data content.
47+
**A**: Data quality, as entailed by the metadata, concerns the completeness of the data documentation and the validity and integrity of the data content. Following DesignSafe curation and documentation best practices, as well as the onboarding instructions on the curation and publication interfaces, and adding a data report or data dictionary enables publishing a complete dataset that others will understand. In addition, in the documentation and/or data description, it is important to clarify the processes conducted to assure the completeness and validity of the data content.
4848

4949
**Q: I have another published work that is related to the project I am now planning to publish. How can I relate them?**
50-
**A**: On the project landing page under Edit Project there is a "Related Work" field where you have the option to include one or more associated projects and publications to your current project. Here, you can provide the title as well as a link to that project or publication. This link can be a DOI or a URL for any content found inside or outside of DesignSafe. For DOIs, please make sure you are adding the entire DOI address starting with "http" to correctly link the webpage to the related project.
50+
**A**: On the project landing page under Edit Project there is a "Related Work" field where you have the option to include one or more associated projects and publications to your current project. Here, you can provide the title as well as a link to that project or publication. This link can be a DOI or a URL for any content found inside or outside of DesignSafe. For DOIs, please make sure you are adding the entire DOI address starting with "http" to correctly link the webpage to the related project.
5151

5252
### Publishing { #publishing }
5353

user-guide/docs/curating/guides.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Look through the Publication Preview early and often to catch any mistakes. If y
114114

115115
#### 8. Prepare to Publish { #step8 }
116116

117-
When you are satisfied with how your work is curated and wish to publish it, select Prepare to Publish in the Publication Preview.
117+
When you are satisfied with how your work is curated and wish to publish it, select Prepare to Publish in the Publication Preview.
118118

119119
![](./imgs/guide-experimental-8.png)
120120

@@ -220,7 +220,7 @@ Click <strong>Remove</strong> if you make any mistakes.
220220

221221
#### 6. Tag Files { #simulation-step6 }
222222

223-
After putting files in categories, dropdowns will appear to allow you to tag specific files.
223+
After putting files in categories, dropdowns will appear to allow you to tag specific files.
224224

225225
![](./imgs/guide-simulation-6.png)
226226

@@ -244,7 +244,7 @@ Look through the Publication Preview early and often to catch any mistakes. If y
244244

245245
![](./imgs/guide-simulation-8a.png)
246246

247-
When you are satisfied with how your work is curated and wish to publish it, select Prepare to Publish in the Publication Preview.
247+
When you are satisfied with how your work is curated and wish to publish it, select Prepare to Publish in the Publication Preview.
248248

249249
![](./imgs/guide-simulation-8b.png)
250250

@@ -273,7 +273,7 @@ Finally, click <strong>Request DOI &amp; Publish</strong> and agree to the agree
273273

274274
<b><i>Field Research User Guide is in progress.</i></b>
275275

276-
#### 1. Add a Project { #fieldresearch-step1 }
276+
#### 1. Add a Project { #fieldresearch-step1 }
277277

278278
![](./imgs/guide-allguides-1a.jpg)
279279

@@ -427,7 +427,7 @@ Finally, click <strong>Request DOI &amp; Publish</strong> and agree to the agree
427427

428428
#### 1. Add a Project { #other-step1 }
429429

430-
To add a new project, click <strong>+ Add</strong>, then select <strong>New Project</strong>.
430+
To add a new project, click <strong>+ Add</strong>, then select <strong>New Project</strong>.
431431

432432
![](./imgs/guide-allguides-1a.jpg)
433433

@@ -445,15 +445,15 @@ Once finished, click <strong>+</strong> <strong>Add Project</strong> and you wil
445445

446446
To begin curating and tagging your files, click on the <strong>Curation Directory</strong> and select <b>Other</b> as your Project Type.
447447

448-
![](./imgs/guide-other-step2a.png)
448+
![](./imgs/guide-other-step2a.png)
449449

450450
Fill out additional required fields in the <strong>Edit Project</strong> window, including a Data Type, then click <strong>Update Project </strong>and you will be brought to the <strong>Curation Directory. </strong>
451451

452452
![](./imgs/guide-other-step2b.png)
453453

454454
#### 3. Tag Files { #other-step3 }
455455

456-
Dropdowns will appear by each file to allow you to tag specific files.
456+
Dropdowns will appear by each file to allow you to tag specific files.
457457

458458
![](./imgs/guide-other-step3.png)
459459

user-guide/docs/curating/metrics.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,27 @@
22

33
### Data Metrics { #data }
44

5-
Data metrics are research impact indicators complementary to other forms of evaluation such as number of paper citations, allowing researchers to assess the repercussions and influence of their work.
5+
Data metrics are research impact indicators complementary to other forms of evaluation such as number of paper citations, allowing researchers to assess the repercussions and influence of their work.
66

7-
Metrics available in DesignSafe follow the Make your Data Count <a href="https://www.projectcounter.org/code-practice-research-data/" target="_blank">Counter Code of Practice for Research Data.</a> This is a community standard to count data usage transparently and in a normalized way. For more information about this approach please visit <a href="https://makedatacount.org/data-metrics-2/" target="_blank">Make your Data Count Metrics</a>.
7+
Metrics available in DesignSafe follow the Make your Data Count <a href="https://www.projectcounter.org/code-practice-research-data/" target="_blank">Counter Code of Practice for Research Data.</a> This is a community standard to count data usage transparently and in a normalized way. For more information about this approach please visit <a href="https://makedatacount.org/data-metrics-2/" target="_blank">Make your Data Count Metrics</a>.
88

99
In Natural Hazards, a research project can encompass more than one data publication which can be produced at different times by different creators and have different DOIs. In DesignSafe, project types are: Other, Experimental, Simulation, Hybrid Simulation, and Field Research. In turn, each has different data publications. Project type "Other" only has one data publication and DOI, while the rest may have more than one data publication and therefore multiple DOIs per project.
1010

11-
<strong>Data Publications:</strong>
11+
<strong>Data Publications:</strong>
1212

13-
Experiment (in Experimental projects)
13+
Experiment (in Experimental projects)
1414

15-
Mission and Document collection (in Field Research projects)
15+
Mission and Document collection (in Field Research projects)
1616

17-
Simulation (in Simulation projects)
17+
Simulation (in Simulation projects)
1818

19-
Hybrid Simulation (in Hybrid Simulation projects)
19+
Hybrid Simulation (in Hybrid Simulation projects)
2020

21-
Other-type project (these encompass only one data publication and thus one level of metrics).
21+
Other-type project (these encompass only one data publication and thus one level of metrics).
2222

23-
Because of the structure of the research projects in DesignSafe we report metrics at the project and at the data publication levels. Metrics at the project level allow researchers to assess the overall impact of the projects because it aggregates the usage of all the data publications. Instead, data publication metrics provide granular information about the usage of each publication that has a DOI within a project.
23+
Because of the structure of the research projects in DesignSafe we report metrics at the project and at the data publication levels. Metrics at the project level allow researchers to assess the overall impact of the projects because it aggregates the usage of all the data publications. Instead, data publication metrics provide granular information about the usage of each publication that has a DOI within a project.
2424

25-
Data Metrics is a work in progress and we add measurements on an ongoing basis. We started counting Project Metrics in March 2021 And Data Publication Metrics in January 2022.
25+
Data Metrics is a work in progress and we add measurements on an ongoing basis. We started counting Project Metrics in March 2021 And Data Publication Metrics in January 2022.
2626

2727
Below are descriptions of each type of metric and what is counted at the project and at the data publication levels.
2828

0 commit comments

Comments
 (0)