getting-started.md

Getting Started with SIPNET

Use this guide to install the prerequisites, build the model, and run your first simulations and tests.

Requirements

• gcc or clang
• make

Quick Start

1. Clone the repository:

   git clone https://github.com/PecanProject/sipnet.git
   cd sipnet

2. Build the SIPNET executable:

   make

3. Change directory and run a test simulation:

   cd tests/smoke/niwot
   ../../../sipnet -i sipnet.in

4. Check the outputs:

   cat sipnet.out
   cat sipnet.config

   The smoke-test configuration in tests/smoke/niwot/sipnet.in enables DUMP_CONFIG, so this run writes both the main model output (sipnet.out) and a merged configuration report (sipnet.config).

Run Tests

• Unit tests:

  make unit
  # or: make testbuild && ./tools/run_unit_tests.sh

• Smoke tests:

  make smoke
  # or: ./tests/smoke/run_smoke.sh

• Full tests (build + unit + smoke):

  make test

• Clean up test artifacts:

  make testclean