update

Stew-McD · Dec 26, 2023 · 4aeca79 · 4aeca79
1 parent ada212b
commit 4aeca79
Show file tree

Hide file tree

Showing 84 changed files with 3,686 additions and 401 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CITATION.cff b/CITATION.cff
@@ -8,7 +8,7 @@ authors:
   given-names: "Lanphere"
   # orcid: "https://orcid.org/0000-0000-0000-0000"
 title: "WasteAndMaterialFootprint"
-version: 0.1.12
+version: 0.1.2
 doi: 10.5281/zenodo.10431181
 date-released: 2023-12-25
 url: "https://github.com/Stew-McD/WasteAndMaterialFootprint"

diff --git a/README.md b/README.md
@@ -14,6 +14,37 @@ The documentation is still under development, but the code is well documented an
 
 The following sections should be enough to go on with.
 
+## Contents
+
+- [WasteAndMaterialFootprint](#wasteandmaterialfootprint)
+  - [Documentation](#documentation)
+  - [Contents](#contents)
+  - [Installation](#installation)
+    - [Dependencies](#dependencies)
+    - [Installation instructions](#installation-instructions)
+  - [Usage](#usage)
+    - [Command line](#command-line)
+    - [Python module](#python-module)
+  - [Configuration](#configuration)
+    - [General settings: `user_settings.py`](#general-settings-user_settingspy)
+    - [Waste search settings: `queries_waste.py`](#waste-search-settings-queries_wastepy)
+      - [Adjusting Search Terms](#adjusting-search-terms)
+        - [Category-Specific Changes](#category-specific-changes)
+        - [Optimizing Search Efficiency](#optimizing-search-efficiency)
+      - [Validating Search Terms](#validating-search-terms)
+    - [Material Search Settings: `queries_materials.py`](#material-search-settings-queries_materialspy)
+      - [Structure and Customisation](#structure-and-customisation)
+        - [Tuple Structure](#tuple-structure)
+        - [Customisation Options](#customisation-options)
+      - [Usage Considerations](#usage-considerations)
+        - [Example Tuples](#example-tuples)
+    - [Examples](#examples)
+    - [Contributing](#contributing)
+    - [License](#license)
+    - [Citation](#citation)
+
+
+
 ## Installation
 
 ### Dependencies

diff --git a/dist/wasteandmaterialfootprint-0.1.12-py3-none-any.whl b/dist/wasteandmaterialfootprint-0.1.12-py3-none-any.whl
diff --git a/dist/wasteandmaterialfootprint-0.1.12.tar.gz b/dist/wasteandmaterialfootprint-0.1.12.tar.gz
diff --git a/dist/wasteandmaterialfootprint-0.1.2-py3-none-any.whl b/dist/wasteandmaterialfootprint-0.1.2-py3-none-any.whl
diff --git a/dist/wasteandmaterialfootprint-0.1.2.tar.gz b/dist/wasteandmaterialfootprint-0.1.2.tar.gz
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
diff --git a/docs/build/doctrees/WasteAndMaterialFootprint.doctree b/docs/build/doctrees/WasteAndMaterialFootprint.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/example_output.doctree b/docs/build/doctrees/example_output.doctree
diff --git a/docs/build/doctrees/index copy.doctree b/docs/build/doctrees/index copy.doctree
diff --git a/docs/build/html/WasteAndMaterialFootprint.html b/docs/build/html/WasteAndMaterialFootprint.html
diff --git a/docs/build/html/_sources/example_output.rst.txt b/docs/build/html/_sources/example_output.rst.txt
@@ -0,0 +1,47 @@
+
+(wmf) stew@SC-McD:~/WMF-test$ python
+Python 3.10.8 (main, Oct  6 2023, 11:32:51) [GCC 12.3.0] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+>>> import WasteAndMaterialFootprint as wmf
+Configuration directory added to Python path: /home/stew/WMF-test/config
+Using environment variable BRIGHTWAY2_DIR for data directory:
+/home/stew/brightway2data
+>>> wmf.run()
+
+    ================================================================================
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+                   ** Starting the WasteAndMaterialFootprint tool **                
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    ================================================================================
+
+Creating 2 new future databases...
+	{'model': 'remind', 'pathway': 'SSP2-Base', 'year': 2030}
+	{'model': 'remind', 'pathway': 'SSP2-Base', 'year': 2100}
+*** Starting FutureScenarios.py ***
+	Using premise version (1, 8, 1)
+Deleted existing project SSP-cutoff-test
+Created new project SSP-cutoff-test from default
+
+** Using: ecoinvent-3.9.1-cutoff**
+
+
+ ** Processing scenario set 1 of 2, batch size 1 **
+
+//////////////////// EXTRACTING SOURCE DATABASE ////////////////////
+Cannot find cached database. Will create one now for next time...
+Getting activity data
+100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 21238/21238 [00:00<00:00, 200349.58it/s]
+Adding exchange data to activities
+100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 674593/674593 [00:23<00:00, 28539.27it/s]
+Filling out exchange data
+100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 21238/21238 [00:01<00:00, 12916.65it/s]
+Set missing location of datasets to global scope.
+Set missing location of production exchanges to scope of dataset.
+Correct missing location of technosphere exchanges.
+Correct missing flow categories for biosphere exchanges
+Remove empty exchanges.
+Done!
+
+////////////////// IMPORTING DEFAULT INVENTORIES ///////////////////
+Cannot find cached inventories. Will create them now for next time...
+Importing default inventories...
diff --git a/docs/build/html/_sources/index copy.rst.txt b/docs/build/html/_sources/index copy.rst.txt
diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.1.12',
+    VERSION: '0.1.2',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/build/html/configuration.html b/docs/build/html/configuration.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Configuration &mdash; WasteAndMaterialFootprint 0.1.12 documentation</title>
+  <title>Configuration &mdash; WasteAndMaterialFootprint 0.1.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,12 +15,14 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=297ad043"></script>
+        <script src="_static/documentation_options.js?v=92734c54"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" /> 
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Examples" href="examples.html" />
+    <link rel="prev" title="Usage" href="usage.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -43,10 +45,35 @@
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
-<ul>
+<ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Configuration</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#general-settings-user-settings-py">General Settings: <code class="docutils literal notranslate"><span class="pre">user_settings.py</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#waste-search-settings-queries-waste-py">Waste Search Settings: <code class="docutils literal notranslate"><span class="pre">queries_waste.py</span></code></a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#categories">Categories</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#query-types">Query Types</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#adjusting-search-terms">Adjusting Search Terms</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#category-specific-changes">Category-Specific Changes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#optimizing-search-efficiency">Optimizing Search Efficiency</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#validating-search-terms">Validating Search Terms</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#material-search-settings-queries-materials-py">Material Search Settings: <code class="docutils literal notranslate"><span class="pre">queries_materials.py</span></code></a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#structure-and-customisation">Structure and Customisation</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#tuple-structure">Tuple Structure</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#customisation-options">Customisation Options</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#usage-considerations">Usage Considerations</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#example-tuples">Example Tuples</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">API Reference</a></li>
 </ul>
@@ -202,7 +229,10 @@ <h4>Example Tuples<a class="headerlink" href="#example-tuples" title="Link to th
 
            </div>
           </div>
-          <footer>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="usage.html" class="btn btn-neutral float-left" title="Usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="examples.html" class="btn btn-neutral float-right" title="Examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
 
   <hr/>
 

diff --git a/docs/build/html/index copy.html → docs/build/html/example_output.html b/docs/build/html/index copy.html → docs/build/html/example_output.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>WasteAndMaterialFootprint: documentation &mdash; WasteAndMaterialFootprint 0.1.12 documentation</title>
+  <title>&lt;no title&gt; &mdash; WasteAndMaterialFootprint 0.1.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=297ad043"></script>
+        <script src="_static/documentation_options.js?v=92734c54"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -46,8 +46,8 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
+<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">API Reference</a></li>
 </ul>
@@ -66,58 +66,59 @@
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
-      <li class="breadcrumb-item active">WasteAndMaterialFootprint: documentation</li>
+      <li class="breadcrumb-item active">&lt;no title&gt;</li>
       <li class="wy-breadcrumbs-aside">
-            <a href="_sources/index copy.rst.txt" rel="nofollow"> View page source</a>
+            <a href="_sources/example_output.rst.txt" rel="nofollow"> View page source</a>
       </li>
   </ul>
   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="wasteandmaterialfootprint-documentation">
-<h1>WasteAndMaterialFootprint: documentation<a class="headerlink" href="#wasteandmaterialfootprint-documentation" title="Link to this heading"></a></h1>
-<div class="toctree-wrapper compound">
-<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="intro.html#motivation">Motivation</a></li>
-<li class="toctree-l2"><a class="reference internal" href="intro.html#limitations">Limitations</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="installation.html#dependencies">Dependencies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="installation.html#installation-instructions">Installation Instructions</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="configuration.html#general-settings-user-settings-py">General Settings: <code class="docutils literal notranslate"><span class="pre">user_settings.py</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="configuration.html#waste-search-settings-queries-waste-py">Waste Search Settings: <code class="docutils literal notranslate"><span class="pre">queries_waste.py</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="configuration.html#material-search-settings-queries-materials-py">Material Search Settings: <code class="docutils literal notranslate"><span class="pre">queries_materials.py</span></code></a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="usage.html#command-line">Command Line</a></li>
-<li class="toctree-l2"><a class="reference internal" href="usage.html#python-module">Python Module</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
-<li class="toctree-l1"><a class="reference internal" href="modules.html">API Reference</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="WasteAndMaterialFootprint.html">WasteAndMaterialFootprint package</a></li>
-</ul>
-</li>
-</ul>
-</div>
-</section>
-<section id="indices-and-tables">
-<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1>
-<ul class="simple">
-<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
-<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
-<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
-</ul>
-</section>
+  <p>(wmf) <a class="reference external" href="mailto:stew&#37;&#52;&#48;SC-McD">stew<span>&#64;</span>SC-McD</a>:~/WMF-test$ python
+Python 3.10.8 (main, Oct  6 2023, 11:32:51) [GCC 12.3.0] on linux
+Type “help”, “copyright”, “credits” or “license” for more information.
+&gt;&gt;&gt; import WasteAndMaterialFootprint as wmf
+Configuration directory added to Python path: /home/stew/WMF-test/config
+Using environment variable BRIGHTWAY2_DIR for data directory:
+/home/stew/brightway2data
+&gt;&gt;&gt; wmf.run()</p>
+<blockquote>
+<div><blockquote>
+<div><p>** Starting the WasteAndMaterialFootprint tool **</p>
+</div></blockquote>
+</div></blockquote>
+<dl class="simple">
+<dt>Creating 2 new future databases…</dt><dd><p>{‘model’: ‘remind’, ‘pathway’: ‘SSP2-Base’, ‘year’: 2030}
+{‘model’: ‘remind’, ‘pathway’: ‘SSP2-Base’, ‘year’: 2100}</p>
+</dd>
+<dt><strong>* Starting FutureScenarios.py *</strong></dt><dd><p>Using premise version (1, 8, 1)</p>
+</dd>
+</dl>
+<p>Deleted existing project SSP-cutoff-test
+Created new project SSP-cutoff-test from default</p>
+<p>** Using: ecoinvent-3.9.1-cutoff**</p>
+<blockquote>
+<div><p>** Processing scenario set 1 of 2, batch size 1 **</p>
+</div></blockquote>
+<p>//////////////////// EXTRACTING SOURCE DATABASE ////////////////////
+Cannot find cached database. Will create one now for next time…
+Getting activity data
+100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 21238/21238 [00:00&lt;00:00, 200349.58it/s]
+Adding exchange data to activities
+100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 674593/674593 [00:23&lt;00:00, 28539.27it/s]
+Filling out exchange data
+100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 21238/21238 [00:01&lt;00:00, 12916.65it/s]
+Set missing location of datasets to global scope.
+Set missing location of production exchanges to scope of dataset.
+Correct missing location of technosphere exchanges.
+Correct missing flow categories for biosphere exchanges
+Remove empty exchanges.
+Done!</p>
+<p>////////////////// IMPORTING DEFAULT INVENTORIES ///////////////////
+Cannot find cached inventories. Will create them now for next time…
+Importing default inventories…</p>
 
 
            </div>