Marzone 4.0 has been largely refactored from its original state. It now is mostly written in C++ and utilizes the object oriented aspects of the language for better encapsulation of different functionalities.
Marzone has been rebuilt in C++ and we are ready for you to test the new version 4.
Upgrades include:
- support for multithreading and parallelization (full utilisation of CPU)
- improved computational speed and efficiency
- additional error reporting
Download for Windows / MacOS / Linux: See releases section.
You can access the code for the new version in a separate branch of this repo: /marzone4
We will officially announce the release of the new version and merge changes to main soon, and are looking for your feedback in the meantime.
Please feel free to use our Google Group. You can also create GitHub issues on this repo or e-mail marxancloud@gmail.com
- Windows x86-64
- Linux x86-64
- MacOS x86-64 (Created in MacOS 10.15 Catalina)
- MacOS M1 (Created in MacOS 11 Big Sur)
- From Google Drive: MarZoneData.zip
- From Releases: MarZoneData.zip
For fast execution:
- set verbosity to 1
- set all annealing trace, savefiles settings to 0 unless you need the specific output
- (If windows) use the .bat file if you want the command window to stay open after execution
If you want to start contributing to the codebase, we encourage you to familiarise yourself with the type of problems that Marzone is intended to solve, and be familiar with the input files and their roles within the program.
- The Marzone manual is located at the marxan website
The original codebase has been rewritten and major parts of it separated into classes. Here is a brief overview of the classes, their dependencies and their intended functionality:
| File/Class | Dependencies | Description |
|---|---|---|
| common.hpp | None | Contains all common data structures for marzone, used by all components of the program |
| util.hpp | None | Contains stand-alone utility functions used by most files in the program |
| logger.hpp | common | Logging functions for debug printing, error/warning printing and writing to log files. |
| costs.hpp/Costs | common, util | Parses cost files and stores information relating to costs, cost names and values. |
| species.hpp/Species | common, util | Parses species file and stores mapping information relating to species lookup, targets and penalties |
| pu.hpp/Pu | species, costs, logger | Parses pu, pulock, puzone, pu connection/bound and puvspr files and stores pu mapping information, pu costs and species amounts in each pu. Also responsible for computations relating to these values |
| zones.hpp/Zones | pu | Parses zone information, zone costs, zone targets, zone boundary, zone contributions and other input files relating to zones. Stores the zone mapping and values relating to zones. Performs computation on these values when needed. |
| reserve.hpp/Reserve | zones | Holds information specific to a single reserve configuration, including its species amounts, shortfall, objective value, connection and costs. Also responsible for computing changes in reserve units. |
The solvers have been moved to /solver folder. Currently Marzone supports the following:
- Simulated Annealing
- Iterative Improvement
- General Heuristic methods specific to Marzone.
- Population Annealing (experimental algorithm)
All solvers depend on reserve, pu, zones and species components. To add a new solver, study and follow the existing pattern of the solvers under /solver.
g++ -O3 -std=c++17 -static -fopenmp marzone.cpp -o bin/MarZone_x64
Install translator from Intel architecture using terminal command:
softwareupdate --install-rosetta
Follow the steps for Mac with x86-64 processor.
From directory with marzone excutable, assign executable flag to marzone
chmod +x ./marzone
Try to run marzone:
./marzone
System will prevent it from running.
Go to System preferences -> Security & Privacy -> Allow apps downloaded from:
Allow to run marzone.
Prerequisites - install cpputest. Please ensure any changes to computation does not break the existing unit tests.
- cd test
- make
- ./test