Thumbnail
DLS-202409-GitHubRepos-navy.pdf

GitHubbing for Open Research

GitHub repositories serve as vital platforms in today’s computational research, allowing scientists to store and share their project code. Although these repositories weren't specifically designed for data storage and preservation, their collaborative features and version control capabilities significantly aid project workflows. To boost their long-term value, we recommend the following best practices.

Perma Link

PDF - ALT
TAGS: Code Documentation, Code Sharing, Dependency Management, GitHub, Reproducibility, Version Control
DATE: 09-2024


Thumbnail
DLS-202401-Binder-navy.pdf

Bundle your Project and Computing Environment with Binder

Binder is an open-source and free service for researchers to create a shareable project version that can be viewed and interacted with within a reproducible computational environment that runs in the cloud via a web browser.

Perma Link

PDF - ALT
TAGS: Code Documentation, Dependency Management, Reproducibility
DATE: 01-2024


Thumbnail
DLS-202312-Venv.pdf

Virtual Environments in Python with Venv

Venv operates independently, ensuring alterations to installed dependencies within one environment remain isolated from others and system-wide libraries. This isolation allows the creation of multiple virtual environments, each hosting its own Python versions and varying sets of libraries.

Perma Link

PDF - ALT
TAGS: Code Documentation, Dependency Management, Reproducibility, Python programming
DATE: 12-2023


Thumbnail
dls-202311-renv-navy_0.pdf

Reproducible Environments with RENV

Is your project R-based? The renv package helps you set up R projects and manage dependencies to keep your environment consistent and reproducible.

Perma Link

 

PDF - ALT
TAGS: Reproducibility, Dependency Management, Code Documentation, R Programming
DATE: 11-2023


Thumbnail
dls-202310-dependencies.pdf

Taming the Dependency Hell

Everybody has a "dependency hell" horror story to tell. In the spookiest month of the year, we describe the leading causes of this problem and how it impacts scientific reproducibility.

Perma Link

PDF - ALT
TAGS: Reproducibility, Dependency Management, Code Documentation
DATE: 10-2023


Thumbnail
dls-n11-2021-codedocumentation-navy.pdf

Championing Code Documentation

Sharing well-documented code along with research data has become essential in today's data-driven computational science.

Perma Link

PDF - ALT
TAGS: Data Documentation, README, Reproducibility, Code Documentation
DATE: 11-2021