Difference between revisions of "Document software by specifying metadata"
From Geoscience Paper of the Future
(→What To Do) |
(→Suggested Readings) |
||
(7 intermediate revisions by the same user not shown) | |||
Line 16: | Line 16: | ||
This training session will be held on May 1, 2015: | This training session will be held on May 1, 2015: | ||
− | * '''Presentation''' | + | * [https://www.dropbox.com/s/5xa7fr57nbfgwnr/DescribingSoftwareThroughMetadata.pdf?dl=0 '''Presentation: Documenting software by specifying metadata'''] |
=== Suggested Readings === | === Suggested Readings === | ||
− | * | + | * [http://www.isi.edu/~gil/papers/gil-etal-kcap15b.pdf "OntoSoft: Capturing Scientific Software Metadata"]. Yolanda Gil, Varun Ratnakar, and Daniel Garijo. Proceedings of the Eighth ACM International Conference on Knowledge Capture, Palisades, NY, October 2015. |
+ | |||
+ | * [http://ontosoft.org/ OntoSoft project description] | ||
+ | |||
+ | * [http://ontosoft.org/ontology/software/ OntoSoft ontology] | ||
== What To Do == | == What To Do == | ||
* Describe your software using the GeoSoft [http://www.geosoft-earthcube.org/portal/ software registry] | * Describe your software using the GeoSoft [http://www.geosoft-earthcube.org/portal/ software registry] | ||
− | ** | + | ** You do not need to log in |
− | ** It will walk you through questions | + | ** Select "Software" from the top, then select "Publish your software" |
− | ** | + | ** It will show you a roadmap of 6 categories and when you select one it will walk you through questions |
+ | ** Special features: | ||
+ | *** If your software is in GitHub, once you provide the URL then GeoSoft will extract some metadata automatically from GitHub and ask you if you want to incorporate it | ||
+ | ** If your software is described in CSDMS or in the NOAAA NCDC repository, it will already be in the system | ||
+ | ** Save the responses when you are done | ||
+ | ** GeoSoft is still a prototype, we appreciate your comments and feedback! | ||
+ | * Once you are done, click on the name of the software | ||
+ | ** At the top you will be able to download an HTML page with the description of the software, which you can put in your code page or project page | ||
+ | ** You can also download RDF/XML or JSON if you prefer | ||
Latest revision as of 21:52, 20 September 2015
What This Task Involves
The training session and training materials indicate how to:
- Describe your software so that others can find it and use it by describing metadata to:
- Uniquely identify the software
- Understand what the software does
- Run the software
- Do research with the software
- Get support if you have questions or find bugs
- Contribute to the development of the software
Training Materials
This training session will be held on May 1, 2015:
Suggested Readings
- "OntoSoft: Capturing Scientific Software Metadata". Yolanda Gil, Varun Ratnakar, and Daniel Garijo. Proceedings of the Eighth ACM International Conference on Knowledge Capture, Palisades, NY, October 2015.
What To Do
- Describe your software using the GeoSoft software registry
- You do not need to log in
- Select "Software" from the top, then select "Publish your software"
- It will show you a roadmap of 6 categories and when you select one it will walk you through questions
- Special features:
- If your software is in GitHub, once you provide the URL then GeoSoft will extract some metadata automatically from GitHub and ask you if you want to incorporate it
- If your software is described in CSDMS or in the NOAAA NCDC repository, it will already be in the system
- Save the responses when you are done
- GeoSoft is still a prototype, we appreciate your comments and feedback!
- Once you are done, click on the name of the software
- At the top you will be able to download an HTML page with the description of the software, which you can put in your code page or project page
- You can also download RDF/XML or JSON if you prefer