Introduction to Apptainer/Singularity

This repository generates the corresponding lesson website from The Carpentries repertoire of lessons.

What is Apptainer/Singularity?

Apptainer (formerly known as Singularity) is a free and open-source container platform that allows you to create and run applications in isolated images (also called "containers") in a simple, portable, fast, and secure manner. It performs operating system level virtualization known as containerization. Many container platforms are available, but Apptainer is designed to bring containers and reproducibility to the scientific community and High-Performance Computing (HPC) use cases. Using Apptainer, developers can work in reproducible environments of their choice and design, and these complete environments can be easily copied and executed on other platforms.

📅 Past events and videos

• 🎥 Jan 2023

Emoji key: 🎥 (full video recordings availabile), ⛏️ (hackathon)

🤗 Contributing

We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any questions, concerns, or experience any difficulties along the way.

If you make non-trivial changes (i.e., more than fixing a simple typo), you are eligible to be added to the HSF Training Community page, as well as to the list of contributors below.

We'd like to ask you to familiarize yourself with our Contribution Guide and have a look at the more detailed guidelines on proper formatting, ways to render the lesson locally, and even how to write new episodes.

Quick summary of how to get a local preview: Install jekyll and then run

bundle install
bundle update
bundle exec jekyll serve

Unless we change framework versions, only the last command needs to be typed after the first time.

Before committing anything, we also ask you to install the pre-commit hooks of this repository:

pip3 install pre-commit
pre-commit install

Please see the current list of issues for ideas for contributing to this repository. For making your contribution, we use the GitHub flow, which is nicely explained in the chapter Contributing to a Project in Pro Git by Scott Chacon. Look for the tag ![good_first_issue], which marks particularly simple issues to get you started.

Citation

To cite this lesson, please consult with CITATION

💖 Authors

Current maintainers of this lesson are

• Michel Villanueva (michmx)

Thanks goes to these wonderful people (emoji key):

Michel H. Villanueva 🖋

Marco Mambelli 🤔 🖋

Aman Goel 🖋

Aman Desai 🖋

This project follows the all-contributors specification. Contributions of any kind welcome!