Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/carpentries-incubator/fair-research-software

A course on tools and practices for open, sustainable and FAIR (Findable, Accessible, Interoperable and Reusable) research software
https://github.com/carpentries-incubator/fair-research-software

carpentries-incubator english fair fair-software lesson pre-alpha research-software

Last synced: 4 days ago
JSON representation

A course on tools and practices for open, sustainable and FAIR (Findable, Accessible, Interoperable and Reusable) research software

Awesome Lists containing this project

README

        

[![DOI](https://zenodo.org/badge/699755985.svg)](https://zenodo.org/doi/10.5281/zenodo.12666088)

# Tools and Practices for FAIR Research Software Course

This short course is teaching tools and practices for producing and sharing quality,
sustainable and [FAIR (Findable, Accessible, Interoperable and Reusable) research software](https://www.nature.com/articles/s41597-022-01710-x)
to support open and reproducible research.
The course can be delivered over 2 full or 4 half days.

The course is visible at: https://carpentries-incubator.github.io/fair-research-software/ and uses [the Markdown lesson template][workbench-markdown-template] from the [The Carpentries Workbench lesson infrastructure][sandpaper-documentation].

The course uses the [software repository with code that does not follow FAIR research software practices](https://github.com/carpentries-incubator/astronaut-data-analysis-not-so-good)
and gradually improves it over the course of the lesson. Finally, the improved code that the course finishes with is in the [astronaut-data-analysis-fair repository](https://github.com/carpentries-incubator/astronaut-data-analysis-fair).

The accompanying [slides](https://docs.google.com/presentation/d/1KahaD7EGxJWXaCDKWAG6Wva4a9zo9Lp-qFyyofgM0vw/edit?usp=sharing) to aid with course delivery are also available.

Launch this lesson on mybinder! 👉 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/carpentries-incubator/fair-research-software/HEAD?urlpath=rstudio)

## Contributing

Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for contributing guidelines and details on how to get involved with this project.

Also see the current list of [issues](https://github.com/softwaresaved/fair-research-software/issues)
for ideas for contributing to this training curriculum. Look for the tag ![good_first_issue](https://img.shields.io/badge/-good%20first%20issue-gold.svg).
This indicates that the issue does not require in-depth knowledge of the project
and lesson infrastructure,
and is a good opportunity for a new contributor to get involved.

To learn more about how this lesson site is built and how you can edit the pages, see [the Introduction to The Carpentries Workbench](https://carpentries.github.io/sandpaper-docs/).

## Author(s)

The list of authors of the course is available in [CITATION.cff](CITATION.cff) (also in [AUTHORS.md](AUTHORS.md)).

## Maintainer(s)

Current Maintainers of this lesson are:

* [Aleksandra Nenadic](https://github.com/anenadic)

## Citation

*Aleksandra Nenadic, Kamilla Kopec-Harding, & S Jaffa. (2024). carpentries-incubator/astronaut-data-analysis-fair: alpha-July-2024 (alpha-July-2024). Zenodo. https://doi.org/10.5281/zenodo.12698943*

Information on how to cite this work is also available in [CITATION.cff](CITATION.cff).

## Contact

Please get in touch with [Aleksandra Nenadic]([email protected]) with any questions about this lesson.

## Acknowledgements

This work has been supported by the [UK's Software Sustainability Institute][ssi] via the [EPSRC, BBSRC, ESRC, NERC, AHRC, STFC and MRC grant EP/S021779/1](https://gow.epsrc.ukri.org/NGBOViewGrant.aspx?GrantRef=EP/S021779/1)
and [UK Reproducibility Network (UKRN)](https://www.ukrn.org/).

[sandpaper-documentation]: https://carpentries.github.io/sandpaper-docs/
[workbench-markdown-template]: https://github.com/carpentries/workbench-template-md/
[ssi]: https:/www.software.ac.uk
[ukrn]: https://www.ukrn.org/