Difference between revisions of "Plan overall timeline"
From Geoscience Paper of the Future
(→Tasks and Timeline) |
(→Tasks and Timeline) |
||
| Line 17: | Line 17: | ||
|2/20 | |2/20 | ||
|'''Ensure software is usable''' | |'''Ensure software is usable''' | ||
| − | |Gather all the software used in the article, including data preparation codes, pre-processing software, visualization software, and any scripts used. Check that all software runs with input data and generates the results as expected. | + | |Gather all the software used in the article, including data preparation codes, pre-processing software, visualization software, and any scripts used. Check that all software runs with input data and generates the results as expected. |
|- | |- | ||
|3/6 | |3/6 | ||
| Line 40: | Line 40: | ||
|- | |- | ||
|5/1 | |5/1 | ||
| − | |||
| − | |||
| − | |||
| − | |||
|'''Document domain characteristics''' | |'''Document domain characteristics''' | ||
|Describe domain data and constraints that help others understand the software. | |Describe domain data and constraints that help others understand the software. | ||
| + | |- | ||
| + | |5/15 | ||
| + | |'''Document quality of software and data''' | ||
| + | |Document adoption of the software, validation, use of benchmarks, reasons for choice of that software, etc. | ||
|- | |- | ||
|5/29 | |5/29 | ||
Revision as of 21:36, 11 February 2015
Tasks and Timeline
This activity will take place in Spring 2015.
| TARGET DATE | GOAL | TASKS |
| 2/6 | Select target articles | Select a paper per person to use for the work. It could be a paper already published or that is in preparation, and can be by the author or by someone else that would be good to reproduce/understand/make available to the community in a better format. |
| 2/20 | Ensure software is usable | Gather all the software used in the article, including data preparation codes, pre-processing software, visualization software, and any scripts used. Check that all software runs with input data and generates the results as expected. |
| 3/6 | Make data accessible | Publish input, intermediate, and final data in a public shared repository (e.g., FigShare), and cite it in the article. |
| 3/11-3/13 | Attend F2F Meeting training | Training and detailed planning |
| 3/20 | Document the provenance of the results | Describe the data flow across software components. Define clearly for each piece of software used in the article what are the inputs and outputs and their data types. |
| 4/3 | Make software executable by others | Ensure that software does not have run-time dependencies that make it difficult for others to run it, provide test data if available. |
| 4/17 | Make software accessible | Publish software in a public repository (e.g., GitHub), use a license, and cite it in the article. Make it easy to track updates and new versions of the software. |
| 5/1 | Document domain characteristics | Describe domain data and constraints that help others understand the software. |
| 5/15 | Document quality of software and data | Document adoption of the software, validation, use of benchmarks, reasons for choice of that software, etc. |
| 5/29 | Prepare the article for publication | Document the methods section, the figures, and the references. |
During the month of June, the articles will be finalized and submitted to a special issue of a journal.
