Getting started
Quick start
- For the beginner, we recommend the following steps:
Review the diagram of a typical workflow, below.
Read the ‘Overview’ subsection (below), and the following two sections (‘Data structures’ and ‘Operations’), to get a general undertsanding of the logic, components, and necessary and optional behaviors of a Geonomics model.
Skim the ‘Parameters’ section, to understand the structure and use of a Geonomics parameters file.
Use pip to install Geonomics (
$ pip install geonomics
);Open Python and run
import geonomics as gnx
;Use the gnx.make_parameters_file function, to begin creating template parameters files that they can tweak as desired;
Use the
gnx.make_model
function and then theModel.walk
orModel.run
methods to instantiate and run the models they’ve parameterized;Use the various
Model.plot
methods to visualize the behavior and results of their models.
As you work through these steps, it may be helpful to refer to the Workflow Diagram for guidance.
Alternatively, you can take a look at our Intro Video for a guided introduction.
Really Quick Start
For the impatient beginner:
Install Geonomics
$ pip install --user geonomics
Launch Python
Import Geonomics
>>> import geonomics as gnx
Run the default model, and start mussin’ around!
>>> mod = gnx.run_default_model()
This will load the Geonomics package as gnx, create a default Geonomics
parameters file in your current working directory, then use that file
to instantiate and run a Model
using the default parameter values.