Skip to content

Latest commit

 

History

History
98 lines (60 loc) · 2.53 KB

README.md

File metadata and controls

98 lines (60 loc) · 2.53 KB

Agtor.jl

Build Status Codecov docs

Agtor - an actor-based zonal agricultural cropping/water management model.

Description

Agtor is designed to facilitate interdisciplinary exploratory scenario modelling of agricultural systems and related system interactions. Agtor operates at a zonal scale where the zone may represent an individual farm/field, sub-catchment area, or the catchment itself.

Based on an earlier version developed for the Lower Campaspe region in North-Central Victoria. See this paper.

Contributions are welcome.

Why the name "Agtor"?

The model represents agricultural actors within a system and so the name is a portmandeau of "agriculture" and "actor".

Tests

Tests are invoked from the project root, like so:

julia> include("test/runtests.jl")

Development Setup

  1. Fork or clone this repository.
  2. Navigate to the project directory and instantiate package environment:
$ julia --project=.

# Activate the package manager
julia> ]

# Instantiate project and dependencies
(Agtor) pkg> instantiate

Examples may use PyCall to interact with the SALib package.

Note: Examples will eventually be updated to use PythonCall.jl instead.

To set up PyCall, define the appropriate Python environment location and run Pkg.build(), for example:

$ conda activate salib

# Example for windows
(salib) $ where python.exe
C:\example\miniconda3\envs\salib\python.exe

(salib) $ julia --project=.

julia> using Pkg

julia> ENV["PYTHON"] = raw"C:\example\miniconda3\envs\salib\python.exe"

julia> Pkg.build("PyCall")
   Building Conda ─→ `...`
   Building PyCall → `...`

julia> using PyCall

julia> py"""
a = 100
"""

julia> py"a"
100

julia> b = py"200"
200

julia> b
200

See PyCall documentation for further details

Tentative usage examples are provided in the examples directory.

Tests are found in the test directory and the runtests.jl will invoke all available tests.

As Agtor is under development all current details are subject to change.