Skip to content

Obtaining code

areanddee edited this page Apr 9, 2025 · 8 revisions

Earthworks is released via git and GitHub within the main model repository. Below are the steps to obtain the Earthwork source code:

  1. Clone the repository git clone git@github.com:EarthWorksOrg/EarthWorks.git my_earthworks_sandbox This will create a directory "my_earthworks_sandbox/" in your current working directory.

  2. By default, the above git clone points to the main branch and the current release tag of Earthworks. To checkout other tags use the following commands (where \<ref\> can be substituted for any appropriate branch or tag name)

    • cd my_earthworks_sandbox; git checkout \<ref\>
    • Or add -b \<ref\> to your git clone command
  3. Checking out external packages. Run: ./bin/git-fleximod update. git-fleximod will populate the Earthworks directory with the relevant versions of the required externals (components and other infrastructure).


Refer to the instructions in Setup, Build, and Run Instructions to begin creating your own cases or tests.

Refer to the instructions in Automated Setup, Build, and Run Instructions if you wish to to try the development team's scripts to create and run multiple cases.

Clone this wiki locally