Welcome to the documentation for the Scientific Filesystem Container Builder example. This documentation and associated repository will help you to turn your scientific software into a tested, reproducible container to share with others. We are going to be combining three technologies to handle each of the following:
- Reproducibility of software is handled by container technology
- Discoverability and Transparency are handled by installing our software in the container via a Scientific Filesystem. SCIF also lets us install the same dependencies across container technologies.
- Testing is handled by continuous integration, which understands how to interact with a scientific filesystem.
Each of these components plays a slightly different and equally important role. Without SCIF, we wouldn’t have any consistency in the commands that we can execute to the container to discovery the software. Without container technologies, you could install software on your host, but (as we all know) this would likely not be a portable solution. Without testing, we couldn’t be sure that our software works as we intended, and is ready to plug into some pipeline tool. The template repository here will help you create a workflow with these steps:
that will ensure your software is packaged, tested, and ready for use! To get started, follow each of the links below to learn how to generate your own his will be consolidated into a tutorial, and for now follow the links below:
- 1. Clone the Repository: The first step is to clone this repository to your Github account.
- 2. Write Your Recipe: The container build and testing is driven by defining your Scientific Filesystem in a recipe.scif
- 3. Build a Container: (optional) you will likely want to build a container, either to develop or run locally.
- 4. Testing Criteria: Once you push to Github, you will need to connect to a Continuous Integration service (CircleCI is used for this repository.
After you write your recipe, making sure to add your scripts and other dependencies to this repository, connect it to test on Circle, and the tests pass, the container will be deployed for others to use.
After setup, you will still want to add new features and otherwise update your software. But since others are likely using it, you need to do this carefully! Here we will give some advice to do this.
- Github Development: if you aren’t familiar with the Github flow to checkout branches for new features and changes.
- Using the Container: How to interact with the SCIF in your container, after you’ve developed it.
- Example: a concrete usage example for the recipe provided in this repository, which has samtools, cufflinks, tophat, and bowtie.
- Tutorial: An additional blog post that walks through how to customize your build.
- https://sci-f.github.io Scientific Filesystem documentation base
- Scientific Filesystem Publication in Gigascience
- Background a bit of background about why we would want to use SCIF in containers, if you don’t want to look over the manuscript.
If you need help, please don’t hesitate to reach out and we will help you!
This is a tool to allow for building, testing, and distribution of reproducible scientific containers. Our goals are the following:...