Skip to content

Commit 35008f1

Browse files
committed
Add conda, homebrew, biocontainers installation docs.
1 parent 707933f commit 35008f1

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,32 @@ R and Python.
6161

6262
# Getting Started
6363

64+
## Installing ADAM via Conda
65+
66+
ADAM is available in Conda via Bioconda, https://bioconda.github.io
67+
68+
```bash
69+
$ conda install adam
70+
```
71+
72+
## Installing ADAM via Homebrew
73+
74+
ADAM is available in Homebrew via Brewsci/bio, https://github.com/brewsci/homebrew-bio
75+
76+
```bash
77+
$ brew install brewsci/bio/adam
78+
```
79+
80+
## Installing ADAM via Docker
81+
82+
ADAM is available in Docker via BioContainers, https://biocontainers.pro
83+
84+
```bash
85+
$ docker pull quay.io/biocontainers/adam:{tag}
86+
```
87+
88+
Find `{tag}` on the tag search page, https://quay.io/repository/biocontainers/adam?tab=tags
89+
6490
## Building from Source
6591

6692
You will need to have [Apache Maven](http://maven.apache.org/) version 3.3.9 or
@@ -77,6 +103,9 @@ $ mvn install
77103
You'll need to have a Spark release on your system and the `$SPARK_HOME` environment variable pointing at it;
78104
prebuilt binaries can be downloaded from the [Spark website](http://spark.apache.org/downloads.html).
79105

106+
As of ADAM version 0.37.0, Spark version 3.2.0 or later is required.
107+
108+
80109
# Documentation
81110

82111
ADAM's documentation is available at http://adam.readthedocs.io.

docs/installation/source.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ will need to have the Spark binaries on your system; prebuilt binaries
3535
can be downloaded from the `Spark
3636
website <http://spark.apache.org/downloads.html>`__.
3737

38+
As of ADAM version 0.37.0, Spark version 3.2.0 or later is required.
39+
3840
Once this alias is in place, you can run ADAM by simply typing
3941
``adam-submit`` at the command line.
4042

@@ -131,11 +133,11 @@ Installation of ``devtools`` may require ``libgit2`` as a dependency.
131133
apt-get install libgit2-dev
132134
133135
The build also requires you to have the ``SparkR`` package installed,
134-
where ``v2.x.x`` should match your Spark version.
136+
where ``v3.x.x`` should match your Spark version.
135137

136138
.. code:: bash
137139
138-
R -e "devtools::install_github('apache/spark@v2.x.x', subdir='R/pkg')"
140+
R -e "devtools::install_github('apache/spark@v3.x.x', subdir='R/pkg')"
139141
140142
The ADAM JARs can then be provided to ``SparkR`` with the following bash
141143
commands:

0 commit comments

Comments
 (0)