-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.html
441 lines (352 loc) · 16.1 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.20.1: https://docutils.sourceforge.io/" />
<title>apsimNGpy: The next generation agroecosytem simulation library</title>
<style type="text/css">
/*
:Author: David Goodger ([email protected])
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="apsimngpy-the-next-generation-agroecosytem-simulation-library">
<h1 class="title">apsimNGpy: The next generation agroecosytem simulation library</h1>
<p>Our cutting-edge open-source framework, apsimNGpy, empowers advanced agroecosystem modeling through the utilization of object-oriented principles. It features fast batch file simulation, model prediction, evaluation,
apsimx file editing, seamless weather data retrieval, and efficient soil profile development</p>
<div class="section" id="installation-1">
<span id="installation"></span><h1>Installation</h1>
<p>you may need a dotnet installation if not installed run the code <a class="reference external" href="https://dotnet.microsoft.com/en-us/download/dotnet/6.0">https://dotnet.microsoft.com/en-us/download/dotnet/6.0</a></p>
<p>First, make sure you have a Python 3 environment installed. Install APSIM and ensure that the directory containing the Models executable is added to the system's PATH or the Python path (to locate the required .dll files). This can be achieved in either of the following ways:</p>
<ol class="loweralpha simple">
<li>Utilize the APSIM installer provided for this purpose.</li>
<li>Build APSIM from its source code. This is comming soon</li>
</ol>
<p>For the current developer versions:</p>
<p>Method 1
.. code:: bash</p>
<blockquote>
git clone <a class="reference external" href="https://github.com/MAGALA-RICHARD/apsimNGpy.git">https://github.com/MAGALA-RICHARD/apsimNGpy.git</a>
cd apsimNGpy
pip install .</blockquote>
<p>Method 2
.. code:: bash</p>
<div class="system-message">
<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">C:/Users/rmagala/Box/apsimNGpy/README.rst</tt>, line 34)</p>
Unexpected indentation.</div>
<blockquote>
pip install git+https://github.com/MAGALA-RICHARD/apsimNGpy.git</blockquote>
<p>if you have apsim installed and the program refuses to load run the following code a the top of your python script before importing any apsimNGpy class</p>
</div>
<div class="section" id="debuging-import-error-due-to-improper-system-apsim-path-configuration">
<h1>Debuging import error due to improper SYSTEM APSIM path configuration</h1>
<pre class="code python literal-block">
<span class="comment single"># search for the program binary installation path and add to os.environ as follows</span><span class="whitespace">
</span><span class="keyword namespace">import</span> <span class="name namespace">os</span><span class="whitespace">
</span><span class="name">os</span><span class="operator">.</span><span class="name">environ</span><span class="punctuation">[</span><span class="literal string single">'APSIM'</span><span class="punctuation">]</span> <span class="operator">=</span><span class="literal string affix">r</span><span class="literal string single">'path/toyourapsimbinaryfolder/bin</span><span class="whitespace">
</span><span class="comment single"># try importing SoilModel class</span><span class="whitespace">
</span><span class="keyword namespace">from</span> <span class="name namespace">apsimNGpy.model.soilmodel</span> <span class="keyword namespace">import</span> <span class="name">SoilModel</span><span class="whitespace">
</span><span class="comment single"># alternatively, you can add the path to the system environmental variables</span>
</pre>
</div>
<div class="section" id="usage-1">
<span id="usage"></span><h1>Usage</h1>
<pre class="code python literal-block">
<span class="keyword namespace">import</span> <span class="name namespace">apsimNGpy</span><span class="whitespace">
</span><span class="keyword namespace">from</span> <span class="name namespace">apsimNGpy.base_data</span> <span class="keyword namespace">import</span> <span class="name">load_example_files</span><span class="whitespace">
</span><span class="keyword namespace">from</span> <span class="name namespace">apsimNGpy.model.soilmodel</span> <span class="keyword namespace">import</span> <span class="name">SoilModel</span><span class="whitespace">
</span><span class="keyword namespace">from</span> <span class="name namespace">pathlib</span> <span class="keyword namespace">import</span> <span class="name">Path</span><span class="whitespace">
</span><span class="keyword namespace">import</span> <span class="name namespace">os</span><span class="whitespace">
</span><span class="keyword namespace">from</span> <span class="name namespace">apsimNGpy.validation</span> <span class="keyword namespace">import</span> <span class="name">plot_data</span><span class="whitespace">
</span><span class="name">cwd</span> <span class="operator">=</span> <span class="name">Path</span><span class="operator">.</span><span class="name">cwd</span><span class="punctuation">()</span><span class="operator">.</span><span class="name">home</span><span class="punctuation">()</span> <span class="comment single"># sending this to your home folder</span><span class="whitespace">
</span><span class="name">wd</span> <span class="operator">=</span> <span class="name">cwd</span><span class="operator">.</span><span class="name">joinpath</span><span class="punctuation">(</span><span class="literal string double">"apsimNGpy_demo"</span><span class="punctuation">)</span><span class="whitespace">
</span><span class="keyword">if</span> <span class="operator word">not</span> <span class="name">wd</span><span class="operator">.</span><span class="name">exists</span><span class="punctuation">():</span><span class="whitespace">
</span> <span class="name">os</span><span class="operator">.</span><span class="name">mkdir</span><span class="punctuation">(</span><span class="name">wd</span><span class="punctuation">)</span><span class="whitespace">
</span><span class="comment single"># change directory</span><span class="whitespace">
</span><span class="name">os</span><span class="operator">.</span><span class="name">chdir</span><span class="punctuation">(</span><span class="name">wd</span><span class="punctuation">)</span><span class="whitespace">
</span><span class="comment single"># Create the data</span><span class="whitespace">
</span><span class="name">data</span> <span class="operator">=</span> <span class="name">load_example_files</span><span class="punctuation">(</span><span class="name">wd</span><span class="punctuation">)</span><span class="whitespace">
</span><span class="comment single"># Get maize model</span><span class="whitespace">
</span><span class="name">maize</span> <span class="operator">=</span> <span class="name">data</span><span class="operator">.</span><span class="name">get_maize</span><span class="punctuation">()</span><span class="whitespace">
</span><span class="comment single"># Initialize the simulation methods</span><span class="whitespace">
</span><span class="name">apsim</span> <span class="operator">=</span> <span class="name">SoilModel</span><span class="punctuation">(</span><span class="name">maize</span><span class="punctuation">,</span> <span class="name">copy</span><span class="operator">=</span><span class="keyword constant">True</span><span class="punctuation">)</span><span class="whitespace">
</span><span class="comment single"># Run the file</span><span class="whitespace">
</span><span class="name">apsim</span><span class="operator">.</span><span class="name">run_edited_file</span><span class="punctuation">()</span><span class="whitespace">
</span><span class="comment single"># print the results</span><span class="whitespace">
</span><span class="name builtin">print</span><span class="punctuation">(</span><span class="name">apsim</span><span class="operator">.</span><span class="name">results</span><span class="punctuation">)</span><span class="whitespace">
</span><span class="comment single"># check the manager modules in the apsim simulation file</span><span class="whitespace">
</span><span class="comment single"># first get the simualtion names</span><span class="whitespace">
</span><span class="name">sim_name</span> <span class="operator">=</span> <span class="name">apsim</span><span class="operator">.</span><span class="name">extract_simulation_name</span><span class="whitespace">
</span><span class="name">apsim</span><span class="operator">.</span><span class="name">examine_management_info</span><span class="punctuation">(</span><span class="name">simulations</span><span class="operator">=</span><span class="name">sim_name</span><span class="punctuation">)</span><span class="whitespace">
</span><span class="comment single"># show current simulation in apsim GUI</span><span class="whitespace">
</span><span class="name">apsim</span><span class="operator">.</span><span class="name">show_file_in_APSIM_GUI</span><span class="punctuation">()</span>
</pre>
</div>
</div>
</body>
</html>