You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@ BioContainers Documentation
2
2
=============================
3
3
4
4
5
-
The BioCotnainers documentation is generated using readthedocs and sphinx. The final version of the documentations is deploy in: https://biocontainers-edu.readthedocs.io/en/latest/
5
+
The BioContainers documentation is generated using readthedocs and sphinx. The final version of the documentation is deployed in: https://biocontainers-edu.readthedocs.io/en/latest/
6
6
7
7
If you want to contribute with the documentation please do a Pull Request (PR) in the branch ``read_docs``.
8
8
9
-
The documentation source files `.rst` are store in the **docs** folder.
9
+
The documentation source files `.rst` are stored in the **docs** folder.
10
10
11
11
If you want to build the project locally, you need to follow these steps:
Copy file name to clipboardExpand all lines: docs/introduction.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Introduction
4
4
Topics
5
5
-------------
6
6
7
-
- Learn basic concepts of containers, docker and BioContainers
7
+
- Learn basic concepts of containers, Docker and BioContainers
8
8
- Get hands to create, deploy and use a BioContainers
9
9
- Master the workflow for deploying and publishing a BioContainer in `Quay.io <https://quay.io/organization/biocontainers>`__ or `DockerHub <https://hub.docker.com/u/biocontainers/>`__
10
10
@@ -20,7 +20,7 @@ Our education portal is work in progress. So if you encounter a logical inconsis
20
20
21
21
- For technical questions related to containers (broken containers, container requests) `Containers Issues <https://github.com/BioContainers/containers/issues>`__ are preferred.
22
22
23
-
If you find a typo or want to help us to make this tutorial even better, you are invited to click on "Improve this page".
23
+
If you find a typo or want to help us to make this tutorial even better, you are invited to click on "Edit on GitHub".
Copy file name to clipboardExpand all lines: docs/what_is_container.rst
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,15 +15,15 @@ Let's install a container quickly:
15
15
16
16
.. note:: This simple command installs dia-umpire and all its dependencies
17
17
18
-
Containers are built from existing operating systems. They are different from virtual machines because they don't posses an entire guest OS inside; instead, containers are built using optimized system libraries and use the host OS memory management and process controls. Containers normally are centralized around a specific software and you can make them executable by instantiating images from them.
18
+
Containers are built from existing operating systems. They are different from virtual machines because they don't possess an entire guest OS inside; instead, containers are built using optimized system libraries and use the host OS memory management and process controls. Containers normally are centralized around a specific software and you can make them executable by instantiating images from them.
19
19
20
20
.. image:: images/container.png
21
-
:alt:What is Container
21
+
:alt:What is a Container
22
22
23
23
Why should I use a container?
24
24
-----------------------------
25
25
26
-
Most of the time when a bioinformatics analysis is performed, several bioinformatics tools and software should be installed and configured. This process can take several hours and demand a lot of effort including the installation of multiple dependencies and tools. BioContainers provide ready-to-use packages and tools that can be easily deployed and used on local machines, HPC and cloud architectures.
26
+
Most of the time when a bioinformatics analysis is performed, several bioinformatics tools and software should be installed and configured. This process can take several hours and demands a lot of effort including the installation of multiple dependencies and tools. BioContainers provide ready-to-use packages and tools that can be easily deployed and used on local machines, HPC and cloud architectures.
27
27
28
28
In the next video you can check out what you can achieve by using docker containers:
29
29
@@ -37,7 +37,7 @@ In the next video you can check out what you can achieve by using docker contain
37
37
Container technologies
38
38
----------------------
39
39
40
-
BioContainers has been built around three main technologies: **Conda**, **Docker** and **Singularity**. The BioContainers Community release for every bioinformatics software containers in these three technologies or flavours.
40
+
BioContainers has been built around three main technologies: **Conda**, **Docker** and **Singularity**. The BioContainers Community releases for every bioinformatics software containers in these three technologies or flavours.
41
41
42
42
.. note:: We do not provide detailed documentation about these three technologies because that can be found on their corresponding web sites, although we may explain some concepts important for understanding BioContainers as needed.
0 commit comments