Skip to content

Commit e3a68e7

Browse files
committed
Revised M6.md
1 parent e03aec7 commit e3a68e7

File tree

17 files changed

+567
-140
lines changed

17 files changed

+567
-140
lines changed

docs/M6.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Economical Suitability Analysis Module is the most recent addition to AEZ framew
77

88
___
99

10-
# Mandatory Functions
10+
## Mandatory Functions
1111

12-
## Initialization of M6 Object Class Creation
12+
### Initialization of M6 Object Class Creation
1313

1414
Firstly, we have to import M6 object class named `EconomicSuitability` to initiate the mandatory process.
1515

@@ -32,7 +32,7 @@ eco = EconomicSuitability.EconomicSuitability()
3232

3333
___
3434

35-
## Crop Economic Data Input
35+
### Crop Economic Data Input
3636

3737
This function allows usres to set up crop-specific parameters for an economic analysis/ The key inputs for Module 5 are the crop yield information which passed through from Module 2 to Module 5 in PyAEZ, market price and the cost of the crop.
3838

@@ -72,9 +72,9 @@ eco.addACrop(crop_name, crop_cost, crop_yield, farm_price, yield_map)
7272

7373
___
7474

75-
# Major Functionalities
75+
## Major Functionalities
7676

77-
## Net Revenue
77+
### Net Revenue
7878

7979
This function returns net revenue from the crop identified with `crop_name`.
8080

@@ -96,7 +96,7 @@ crop_rev = eco.getNetRevenue(crop_name)
9696

9797
___
9898

99-
## Classified Net Revenue
99+
### Classified Net Revenue
100100

101101
This function returns classified net revenue for the crop `crop_name`. This classified scheme for crop net revenue is provided in the table below.
102102

@@ -133,7 +133,7 @@ crop_rev_class = eco.getClassifiedNetRevenue(crop_name)
133133

134134
___
135135

136-
## Normalized Net Revenue
136+
### Normalized Net Revenue
137137

138138
This function returns the normalized net revenue for the crop `crop_name`, which requires at least two crops to be provided in the crop economic data input. This classification checks the net revenues for all crops and select the maximum net revenue value of the crop (known as umbrella crop) and is compared with user-specified crop net revenue to generate normalized net revenue. After normalization, the normalized values are classified to six major classes, providing the comparative performance information of the economic crops.
139139

site/404.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717

1818

19-
<title>PyAEZ v2.4 Documentation</title>
19+
<title>PyAEZ v2.3 Documentation</title>
2020

2121

2222

@@ -79,7 +79,7 @@
7979

8080
<header class="md-header md-header--shadow" data-md-component="header">
8181
<nav class="md-header__inner md-grid" aria-label="Header">
82-
<a href="/." title="PyAEZ v2.4 Documentation" class="md-header__button md-logo" aria-label="PyAEZ v2.4 Documentation" data-md-component="logo">
82+
<a href="/." title="PyAEZ v2.3 Documentation" class="md-header__button md-logo" aria-label="PyAEZ v2.3 Documentation" data-md-component="logo">
8383

8484

8585
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -93,7 +93,7 @@
9393
<div class="md-header__ellipsis">
9494
<div class="md-header__topic">
9595
<span class="md-ellipsis">
96-
PyAEZ v2.4 Documentation
96+
PyAEZ v2.3 Documentation
9797
</span>
9898
</div>
9999
<div class="md-header__topic" data-md-component="header-topic">
@@ -212,13 +212,13 @@
212212

213213
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
214214
<label class="md-nav__title" for="__drawer">
215-
<a href="/." title="PyAEZ v2.4 Documentation" class="md-nav__button md-logo" aria-label="PyAEZ v2.4 Documentation" data-md-component="logo">
215+
<a href="/." title="PyAEZ v2.3 Documentation" class="md-nav__button md-logo" aria-label="PyAEZ v2.3 Documentation" data-md-component="logo">
216216

217217

218218
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
219219

220220
</a>
221-
PyAEZ v2.4 Documentation
221+
PyAEZ v2.3 Documentation
222222
</label>
223223

224224
<div class="md-nav__source">

site/About/index.html

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121

2222

23-
<title>About - PyAEZ v2.4 Documentation</title>
23+
<title>About - PyAEZ v2.3 Documentation</title>
2424

2525

2626

@@ -88,7 +88,7 @@
8888

8989
<header class="md-header md-header--shadow" data-md-component="header">
9090
<nav class="md-header__inner md-grid" aria-label="Header">
91-
<a href=".." title="PyAEZ v2.4 Documentation" class="md-header__button md-logo" aria-label="PyAEZ v2.4 Documentation" data-md-component="logo">
91+
<a href=".." title="PyAEZ v2.3 Documentation" class="md-header__button md-logo" aria-label="PyAEZ v2.3 Documentation" data-md-component="logo">
9292

9393

9494
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -102,7 +102,7 @@
102102
<div class="md-header__ellipsis">
103103
<div class="md-header__topic">
104104
<span class="md-ellipsis">
105-
PyAEZ v2.4 Documentation
105+
PyAEZ v2.3 Documentation
106106
</span>
107107
</div>
108108
<div class="md-header__topic" data-md-component="header-topic">
@@ -221,13 +221,13 @@
221221

222222
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
223223
<label class="md-nav__title" for="__drawer">
224-
<a href=".." title="PyAEZ v2.4 Documentation" class="md-nav__button md-logo" aria-label="PyAEZ v2.4 Documentation" data-md-component="logo">
224+
<a href=".." title="PyAEZ v2.3 Documentation" class="md-nav__button md-logo" aria-label="PyAEZ v2.3 Documentation" data-md-component="logo">
225225

226226

227227
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
228228

229229
</a>
230-
PyAEZ v2.4 Documentation
230+
PyAEZ v2.3 Documentation
231231
</label>
232232

233233
<div class="md-nav__source">
@@ -680,7 +680,7 @@ <h2 id="what-is-pyaez">What is PyAEZ?<a class="headerlink" href="#what-is-pyaez"
680680
<p>PyAEZ package consists of six main AEZ modules and one additional utility module stated as below:</p>
681681
<ul>
682682
<li>
683-
<p>Module 1: Climate regime - calculation of agro-climatic indicators for evaluation of climatic suitability of crops.</p>
683+
<p><strong>Module 1: Climate regime</strong> - calculation of agro-climatic indicators for evaluation of climatic suitability of crops.</p>
684684
</li>
685685
<li>
686686
<p><strong>Module 2: Crop simulation</strong> - simulate an optimal crop cycle for the highest attainable yield.</p>
@@ -707,6 +707,27 @@ <h2 id="what-is-pyaez">What is PyAEZ?<a class="headerlink" href="#what-is-pyaez"
707707

708708

709709

710+
711+
712+
713+
714+
715+
716+
<aside class="md-source-file">
717+
718+
719+
<span class="md-source-file__fact">
720+
<span class="md-icon" title="Last update">
721+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
722+
</span>
723+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime" title="May 21, 2025 04:50:51">May 21, 2025 04:50:51</span>
724+
</span>
725+
726+
727+
728+
729+
730+
</aside>
710731

711732

712733

site/Acknowledgements/index.html

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121

2222

23-
<title>Acknowledgements - PyAEZ v2.4 Documentation</title>
23+
<title>Acknowledgements - PyAEZ v2.3 Documentation</title>
2424

2525

2626

@@ -88,7 +88,7 @@
8888

8989
<header class="md-header md-header--shadow" data-md-component="header">
9090
<nav class="md-header__inner md-grid" aria-label="Header">
91-
<a href=".." title="PyAEZ v2.4 Documentation" class="md-header__button md-logo" aria-label="PyAEZ v2.4 Documentation" data-md-component="logo">
91+
<a href=".." title="PyAEZ v2.3 Documentation" class="md-header__button md-logo" aria-label="PyAEZ v2.3 Documentation" data-md-component="logo">
9292

9393

9494
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -102,7 +102,7 @@
102102
<div class="md-header__ellipsis">
103103
<div class="md-header__topic">
104104
<span class="md-ellipsis">
105-
PyAEZ v2.4 Documentation
105+
PyAEZ v2.3 Documentation
106106
</span>
107107
</div>
108108
<div class="md-header__topic" data-md-component="header-topic">
@@ -221,13 +221,13 @@
221221

222222
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
223223
<label class="md-nav__title" for="__drawer">
224-
<a href=".." title="PyAEZ v2.4 Documentation" class="md-nav__button md-logo" aria-label="PyAEZ v2.4 Documentation" data-md-component="logo">
224+
<a href=".." title="PyAEZ v2.3 Documentation" class="md-nav__button md-logo" aria-label="PyAEZ v2.3 Documentation" data-md-component="logo">
225225

226226

227227
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
228228

229229
</a>
230-
PyAEZ v2.4 Documentation
230+
PyAEZ v2.3 Documentation
231231
</label>
232232

233233
<div class="md-nav__source">
@@ -565,16 +565,37 @@
565565

566566

567567
<h1 id="acknowledgements">Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permanent link">&para;</a></h1>
568-
<p>The free and open source package Python Agro-Ecological Zoning (PyAEZ) was developed to address country-specific spatial information needs on future agricultural production. The finalization of this publication was led by Dr. Manzul Kumar Hazarika, Dr. Kittiphon Boonma and Swun Wunna Htet are the main authors for this publication with technical advice and contribution from Prof. Rajendra P. Shrestha.</p>
569-
<p>The authors acknowledge the contribution from the Asian Institute of Technology - Geoinformatics Center and the Food and Agriculture Organization of the United Nations (FAO) through the Geospatial Unit and the Regional Office for Asia and the Pacific (FAO-RAP). The PyAEZ development received financial support under a regional initiative on “Capacity building for Agro-Ecological Zone (AEZ) mapping and modelling to project climate suitability of crops and land uses” in collaboration with the FAO-RAP and the “Strengthening agro-climatic monitoring and information systems to improve adaptation to climate change and food security in Lao PDR (GCP /LAO/021/LDF)” project. The code development received contribution from Lakmal Nawarathnage, Thaileng Thol, Gianluca Franceschini, Shraddha Sharma, Dr. Kavinda Gunasekara, Dr. Kittiphon Boonma, Swun Wunna Htet and Dwijendra Das.</p>
570-
<p>This achievement would have not been made possible without the continuous technical contribution and advice from Günther Fischer from the International Institute for Applied Systems Analysis (IIASA) and Freddy Nachtergaele. The authors are also grateful for the financial and management support from FAO, especially Beau Damon, Monica Petri, Federica Chiozza, Joyce Ahimbisibwe, Dario Spiller, Rutendo Mukaratirwa and Matieu Henry.</p>
568+
<p>The free and open source package Python Agro-Ecological Zoning (PyAEZ) was developed to address country-specific spatial information needs on future agricultural production. The finalization of this web-based PyAEZ documentation was done by Swun Wunna Htet, Senior Research Associate of GIC-AIT.</p>
569+
<p>The authors acknowledge the contribution from the Asian Institute of Technology - Geoinformatics Center (GIC-AIT) and the Food and Agriculture Organization of the United Nations (FAO) through the Geospatial Unit and the Regional Office for Asia and the Pacific (FAO-RAP). The PyAEZ development received financial support under a regional initiative on “Capacity building for Agro-Ecological Zone (AEZ) mapping and modelling to project climate suitability of crops and land uses” in collaboration with the FAO-RAP and the “Strengthening agro-climatic monitoring and information systems to improve adaptation to climate change and food security in Lao PDR (GCP /LAO/021/LDF)” project. The code development received contribution from Lakmal Nawarathnage, Thaileng Thol, Gianluca Franceschini, Shraddha Sharma, Dr. Kavinda Gunasekara, Dr. Kittiphon Boonma, Swun Wunna Htet and Dwijendra Das.</p>
570+
<p>This achievement would have not been made possible without the continuous technical contribution and advice from Günther Fischer from the International Institute for Applied Systems Analysis (IIASA) and Freddy Nachtergaele. The authors are also grateful for the financial, management and technical support from FAO, especially Beau Damon, Monica Petri, Federica Chiozza, Joyce Ahimbisibwe, Dario Spiller, Rutendo Mukaratirwa, Filippo Sarvia and Matieu Henry.</p>
571571

572572

573573

574574

575575

576576

577577

578+
579+
580+
581+
582+
583+
584+
<aside class="md-source-file">
585+
586+
587+
<span class="md-source-file__fact">
588+
<span class="md-icon" title="Last update">
589+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
590+
</span>
591+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime" title="May 21, 2025 04:50:51">May 21, 2025 04:50:51</span>
592+
</span>
593+
594+
595+
596+
597+
598+
</aside>
578599

579600

580601

0 commit comments

Comments
 (0)