Skip to content

Commit 8ac0313

Browse files
NokuzaSezo97NokuzaSezo97
committed
Deployed e3a68e7 with MkDocs version: 1.6.1
1 parent 47b02c6 commit 8ac0313

File tree

1 file changed

+197
-8
lines changed

1 file changed

+197
-8
lines changed

‎M6/index.html‎

Lines changed: 197 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -470,6 +470,18 @@
470470

471471

472472

473+
<label class="md-nav__link md-nav__link--active" for="__toc">
474+
475+
476+
<span class="md-ellipsis">
477+
Module 6 (Economic Suitability)
478+
479+
</span>
480+
481+
482+
<span class="md-nav__icon md-icon"></span>
483+
</label>
484+
473485
<a href="./" class="md-nav__link md-nav__link--active">
474486

475487

@@ -481,6 +493,100 @@
481493

482494
</a>
483495

496+
497+
498+
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
499+
500+
501+
502+
503+
504+
505+
<label class="md-nav__title" for="__toc">
506+
<span class="md-nav__icon md-icon"></span>
507+
Table of contents
508+
</label>
509+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
510+
511+
<li class="md-nav__item">
512+
<a href="#mandatory-functions" class="md-nav__link">
513+
<span class="md-ellipsis">
514+
Mandatory Functions
515+
</span>
516+
</a>
517+
518+
<nav class="md-nav" aria-label="Mandatory Functions">
519+
<ul class="md-nav__list">
520+
521+
<li class="md-nav__item">
522+
<a href="#initialization-of-m6-object-class-creation" class="md-nav__link">
523+
<span class="md-ellipsis">
524+
Initialization of M6 Object Class Creation
525+
</span>
526+
</a>
527+
528+
</li>
529+
530+
<li class="md-nav__item">
531+
<a href="#crop-economic-data-input" class="md-nav__link">
532+
<span class="md-ellipsis">
533+
Crop Economic Data Input
534+
</span>
535+
</a>
536+
537+
</li>
538+
539+
</ul>
540+
</nav>
541+
542+
</li>
543+
544+
<li class="md-nav__item">
545+
<a href="#major-functionalities" class="md-nav__link">
546+
<span class="md-ellipsis">
547+
Major Functionalities
548+
</span>
549+
</a>
550+
551+
<nav class="md-nav" aria-label="Major Functionalities">
552+
<ul class="md-nav__list">
553+
554+
<li class="md-nav__item">
555+
<a href="#net-revenue" class="md-nav__link">
556+
<span class="md-ellipsis">
557+
Net Revenue
558+
</span>
559+
</a>
560+
561+
</li>
562+
563+
<li class="md-nav__item">
564+
<a href="#classified-net-revenue" class="md-nav__link">
565+
<span class="md-ellipsis">
566+
Classified Net Revenue
567+
</span>
568+
</a>
569+
570+
</li>
571+
572+
<li class="md-nav__item">
573+
<a href="#normalized-net-revenue" class="md-nav__link">
574+
<span class="md-ellipsis">
575+
Normalized Net Revenue
576+
</span>
577+
</a>
578+
579+
</li>
580+
581+
</ul>
582+
</nav>
583+
584+
</li>
585+
586+
</ul>
587+
588+
</nav>
589+
484590
</li>
485591

486592

@@ -547,6 +653,89 @@
547653

548654

549655

656+
<label class="md-nav__title" for="__toc">
657+
<span class="md-nav__icon md-icon"></span>
658+
Table of contents
659+
</label>
660+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
661+
662+
<li class="md-nav__item">
663+
<a href="#mandatory-functions" class="md-nav__link">
664+
<span class="md-ellipsis">
665+
Mandatory Functions
666+
</span>
667+
</a>
668+
669+
<nav class="md-nav" aria-label="Mandatory Functions">
670+
<ul class="md-nav__list">
671+
672+
<li class="md-nav__item">
673+
<a href="#initialization-of-m6-object-class-creation" class="md-nav__link">
674+
<span class="md-ellipsis">
675+
Initialization of M6 Object Class Creation
676+
</span>
677+
</a>
678+
679+
</li>
680+
681+
<li class="md-nav__item">
682+
<a href="#crop-economic-data-input" class="md-nav__link">
683+
<span class="md-ellipsis">
684+
Crop Economic Data Input
685+
</span>
686+
</a>
687+
688+
</li>
689+
690+
</ul>
691+
</nav>
692+
693+
</li>
694+
695+
<li class="md-nav__item">
696+
<a href="#major-functionalities" class="md-nav__link">
697+
<span class="md-ellipsis">
698+
Major Functionalities
699+
</span>
700+
</a>
701+
702+
<nav class="md-nav" aria-label="Major Functionalities">
703+
<ul class="md-nav__list">
704+
705+
<li class="md-nav__item">
706+
<a href="#net-revenue" class="md-nav__link">
707+
<span class="md-ellipsis">
708+
Net Revenue
709+
</span>
710+
</a>
711+
712+
</li>
713+
714+
<li class="md-nav__item">
715+
<a href="#classified-net-revenue" class="md-nav__link">
716+
<span class="md-ellipsis">
717+
Classified Net Revenue
718+
</span>
719+
</a>
720+
721+
</li>
722+
723+
<li class="md-nav__item">
724+
<a href="#normalized-net-revenue" class="md-nav__link">
725+
<span class="md-ellipsis">
726+
Normalized Net Revenue
727+
</span>
728+
</a>
729+
730+
</li>
731+
732+
</ul>
733+
</nav>
734+
735+
</li>
736+
737+
</ul>
738+
550739
</nav>
551740
</div>
552741
</div>
@@ -569,8 +758,8 @@ <h1 id="introduction">Introduction<a class="headerlink" href="#introduction" tit
569758
<p><strong>Figure: Overview of Module VI: Economic Suitability</strong>
570759
<img alt="Alt text" src="../assets/M6_overview.png" /></p>
571760
<hr />
572-
<h1 id="mandatory-functions">Mandatory Functions<a class="headerlink" href="#mandatory-functions" title="Permanent link">&para;</a></h1>
573-
<h2 id="initialization-of-m6-object-class-creation">Initialization of M6 Object Class Creation<a class="headerlink" href="#initialization-of-m6-object-class-creation" title="Permanent link">&para;</a></h2>
761+
<h2 id="mandatory-functions">Mandatory Functions<a class="headerlink" href="#mandatory-functions" title="Permanent link">&para;</a></h2>
762+
<h3 id="initialization-of-m6-object-class-creation">Initialization of M6 Object Class Creation<a class="headerlink" href="#initialization-of-m6-object-class-creation" title="Permanent link">&para;</a></h3>
574763
<p>Firstly, we have to import M6 object class named <code>EconomicSuitability</code> to initiate the mandatory process.</p>
575764
<div class="language-py highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">Initializing M6 Object</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
576765
<span class="normal"><a href="#__codelineno-0-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="kn">from</span> <span class="nn">pyaez</span> <span class="kn">import</span> <span class="n">EconomicSuitability</span>
@@ -615,7 +804,7 @@ <h2 id="initialization-of-m6-object-class-creation">Initialization of M6 Object
615804
</tbody>
616805
</table>
617806
<hr />
618-
<h2 id="crop-economic-data-input">Crop Economic Data Input<a class="headerlink" href="#crop-economic-data-input" title="Permanent link">&para;</a></h2>
807+
<h3 id="crop-economic-data-input">Crop Economic Data Input<a class="headerlink" href="#crop-economic-data-input" title="Permanent link">&para;</a></h3>
619808
<p>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.</p>
620809
<p>This mandatory function can be called multiple times if users want to import multiple crop-specific information. However, at least one crop data should be provided. If users want to analyze comparative economic analysis at least two crop data should be provided.</p>
621810
<div class="language-py highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">Import Crop Eco data</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-1-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a><span class="n">eco</span><span class="o">.</span><span class="n">addACrop</span><span class="p">(</span><span class="n">crop_name</span><span class="p">,</span> <span class="n">crop_cost</span><span class="p">,</span> <span class="n">crop_yield</span><span class="p">,</span> <span class="n">farm_price</span><span class="p">,</span> <span class="n">yield_map</span><span class="p">)</span>
@@ -703,8 +892,8 @@ <h2 id="crop-economic-data-input">Crop Economic Data Input<a class="headerlink"
703892
</ul>
704893
</div>
705894
<hr />
706-
<h1 id="major-functionalities">Major Functionalities<a class="headerlink" href="#major-functionalities" title="Permanent link">&para;</a></h1>
707-
<h2 id="net-revenue">Net Revenue<a class="headerlink" href="#net-revenue" title="Permanent link">&para;</a></h2>
895+
<h2 id="major-functionalities">Major Functionalities<a class="headerlink" href="#major-functionalities" title="Permanent link">&para;</a></h2>
896+
<h3 id="net-revenue">Net Revenue<a class="headerlink" href="#net-revenue" title="Permanent link">&para;</a></h3>
708897
<p>This function returns net revenue from the crop identified with <code>crop_name</code>.</p>
709898
<div class="language-py highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">Get net revenue</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-2-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1"></a><span class="n">crop_rev</span> <span class="o">=</span> <span class="n">eco</span><span class="o">.</span><span class="n">getNetRevenue</span><span class="p">(</span><span class="n">crop_name</span><span class="p">)</span>
710899
</span></code></pre></div></td></tr></table></div>
@@ -747,7 +936,7 @@ <h2 id="net-revenue">Net Revenue<a class="headerlink" href="#net-revenue" title=
747936
</tbody>
748937
</table>
749938
<hr />
750-
<h2 id="classified-net-revenue">Classified Net Revenue<a class="headerlink" href="#classified-net-revenue" title="Permanent link">&para;</a></h2>
939+
<h3 id="classified-net-revenue">Classified Net Revenue<a class="headerlink" href="#classified-net-revenue" title="Permanent link">&para;</a></h3>
751940
<p>This function returns classified net revenue for the crop <code>crop_name</code>. This classified scheme for crop net revenue is provided in the table below.</p>
752941
<p>This classification is based on identification of minimum and maximum value of net revenue in a given area of interest. The net revenue percentage is delineated between zero percent (minimum net revenue) and 100 (maximum net revenue), and seven classes are divided based on percentage ranges.</p>
753942
<div class="language-py highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">Get classified net revenue</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-3-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1"></a><span class="n">crop_rev_class</span> <span class="o">=</span> <span class="n">eco</span><span class="o">.</span><span class="n">getClassifiedNetRevenue</span><span class="p">(</span><span class="n">crop_name</span><span class="p">)</span>
@@ -843,7 +1032,7 @@ <h2 id="classified-net-revenue">Classified Net Revenue<a class="headerlink" href
8431032
</tbody>
8441033
</table>
8451034
<hr />
846-
<h2 id="normalized-net-revenue">Normalized Net Revenue<a class="headerlink" href="#normalized-net-revenue" title="Permanent link">&para;</a></h2>
1035+
<h3 id="normalized-net-revenue">Normalized Net Revenue<a class="headerlink" href="#normalized-net-revenue" title="Permanent link">&para;</a></h3>
8471036
<p>This function returns the normalized net revenue for the crop <code>crop_name</code>, 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.</p>
8481037
<div class="language-py highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">Get normalized net revenue</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-4-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1"></a><span class="n">crop_rev_norm</span> <span class="o">=</span> <span class="n">eco</span><span class="o">.</span><span class="n">getNormalizedNetRevenue</span><span class="p">(</span><span class="n">crop_name</span><span class="p">)</span>
8491038
</span></code></pre></div></td></tr></table></div>
@@ -948,7 +1137,7 @@ <h2 id="normalized-net-revenue">Normalized Net Revenue<a class="headerlink" href
9481137
<span class="md-icon" title="Last update">
9491138
<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>
9501139
</span>
951-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime" title="May 16, 2025 10:24:35">May 16, 2025 10:24:35</span>
1140+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime" title="May 21, 2025 07:07:29">May 21, 2025 07:07:29</span>
9521141
</span>
9531142

9541143

0 commit comments

Comments
 (0)