shamba-model/shamba

Smallholder Agriculture Monitoring and Baseline Assessment tool # Small-Holder Agriculture Mitigation Benefit Assessment (SHAMBA) model, version 1.2 Instructions on how to setup and use SHAMBA are below. The docs folder contains the detailed scientific description of the model and a user guide. For documentation on how to implement the Plan Vivo approved methodology, see the Plan Vivo website at: planvivo.org See the instructions in the `shamba_command_line.py` file for details on how to run SHAMBA with the data-input-templates. The script is already set up to run the example input from the `example_SHAMBA_input_output_uganda_tech_spec.xlsx` file. For help, contact shamba@ed.ac.uk ## Getting Started with SHAMBA In v1.2, SHAMBA is only available as a command-line version. The `shamba_command_line.py` script will prompt you for the information it needs to run the model. It will also print out instructions on how to prepare input data to run the model. A web application is targeted for future versions. You may find some proof-of-concept files in this repo, but this is not set up for full use yet and should be ignored. Command-line setup can either use a Docker container, or locally installed packages. ### 1. Docker Setup 1. Ensure that Docker is installed on your system. Check the official documentation for how to install Docker for your specific operating system. 2. In the terminal, from the `shamba` directory, run the following command: ```sh docker compose up ``` Please note: the first time you run `docker compose up`, the command may take several minutes. Future runs of that command will be much faster. To use SHAMBA from within the Docker container, follow these steps in the terminal: 1. Find the container ID of the running container: `docker ps`. Grab the ID of the `shamba-server` container. 2. Run the following command: `docker exec -it bash` 3. Run `cd ..` to go back to the `shamba` directory. 4. Run `poetry run python shamba_command_line.py` to run the model. ### 2. Local Setup To set up …