Getting Started

Step One: Install Conda MOOSE Environment

In order to install Zapdos, the MOOSE developer environment must be installed. The installation procedure depends on your operating system, so click on the MOOSE website link below that corresponds to your operation system/platform and follow the instructions to the conda installation step named "Cloning MOOSE". Then, return to this page and continue with Step Two.

Advanced manual installation instructions for this environment are available via the MOOSE website.

If an error or other issue is experienced while using the conda environment, please see the MOOSE troubleshooting guide for Conda

Step Two: Clone Zapdos

Zapdos is hosted on GitHub, and should be cloned directly from there using git. As in the MOOSE directions, it is recommended that users create a directory named "projects" to put all of your MOOSE-related work.

To clone Zapdos, run the following commands in Terminal:


mkdir ~/projects
cd ~/projects
git clone https://github.com/shannon-lab/zapdos.git
cd zapdos
git checkout master

Step Three: Build and Test Zapdos

To compile Zapdos, first make sure that the conda MOOSE environment is activated (and be sure to do this any time that a new Terminal window is opened):


conda activate moose

Then navigate to the Zapdos clone directory and download the MOOSE submodule:


cd ~/projects/zapdos
git submodule update --init squirrel crane moose
commentnote

The copy of MOOSE provided with Zapdos has been fully tested against the current Zapdos version, and is guaranteed to work with all current Zapdos tests.

Once all dependencies have been downloaded, Zapdos can be compiled and tested:


make -j8
./run_tests -j8

If Zapdos is working correctly, all active tests will pass. This indicates that Zapdos is ready to be used and further developed.

Updating Zapdos

To update Zapdos, it is recommended to use fetch and rebase:


cd ~/projects/zapdos
git fetch origin
git rebase origin/master

Alternate Installation: Docker

Zapdos is also available as a container hosted on Docker Hub in the repository shannonlab/zapdos for Ubuntu 20.04. The tag "latest" is kept current with the master branch of the Zapdos repository, and the other tags are commit hashes in line with git commit hashes for prior Zapdos updates. The Docker image contains a prebuilt copy of Zapdos, installable with two commands (once Docker is installed on the host machine):


docker pull shannonlab/zapdos:latest

then


docker run -ti shannonlab/zapdos:latest

Zapdos Docker Container Minimum System Requirements

  • Some flavor of Linux, MacOS, or Windows with Docker installed

  • Memory: 16 GBs (debug builds)

  • Processor: 64-bit x86 or ARM64 (Apple Silicon)

  • Disk: 6 GB (image size)

Troubleshooting

If issues are experienced in installation and testing, several resources are available:

What next?

With installation and testing complete, proceed to Using Zapdos.