Bump version to 0.7.2

[Diff since v0.5.1](https://github.com/ANL-CEEESA/RELOG/compare/v0.5.1...v0.5.2)

.github/workflows/lint.yml

@@ -14,10 +14,10 @@ jobs:
         shell: julia --color=yes {0}
         run: |
           using Pkg
-          Pkg.add(PackageSpec(name="JuliaFormatter", version="0.14.4"))
+          Pkg.add(PackageSpec(name="JuliaFormatter", version="1"))
           using JuliaFormatter
           format("src", verbose=true)
-          format("test", verbose=true)
+          format("test/src", verbose=true)
           out = String(read(Cmd(`git diff`)))
           if isempty(out)
               exit(0)

.github/workflows/test.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        version: ['1.3', '1.4', '1.5', '1.6']
+        version: ['1.6', '1.7', '1.8']
         os:
           - ubuntu-latest
         arch:
@@ -21,5 +21,15 @@ jobs:
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: julia-actions/julia-buildpkg@v1
-      - uses: julia-actions/julia-runtest@v1
+      - name: Run tests
+        shell: julia --color=yes --project=test {0}
+        run: |
+          using Pkg
+          Pkg.develop(path=".")
+          Pkg.update()
+          using RELOGT
+          try
+            runtests()
+          catch
+            exit(1)
+          end

.zenodo.json

@@ -0,0 +1,28 @@
+{
+  "creators": [
+    {
+      "orcid": "0000-0002-5022-9802",
+      "affiliation": "Argonne National Laboratory",
+      "name": "Santos Xavier, Alinson"
+    },
+    {
+      "orcid": "0000-0002-3426-9425",
+      "affiliation": "Argonne National Laboratory",
+      "name": "Iloeje, Chukwunwike"
+    },
+    {
+      "affiliation": "Argonne National Laboratory",
+      "name": "Atkins, John"
+    },
+    {
+      "affiliation": "Argonne National Laboratory",
+      "name": "Sun, Kyle"
+    },
+    {
+      "affiliation": "Argonne National Laboratory",
+      "name": "Gallier, Audrey"
+    }
+  ],
+  "title": "RELOG: Reverse Logistics Optimization",
+  "description": "<b>RELOG</b> is a supply chain optimization package focusing on reverse logistics and reverse manufacturing. For example, the package can be used to determine where to build recycling plants, what sizes should they have and which customers should be served by which plants. The package supports customized reverse logistics pipelines, with multiple types of plants, multiple types of product and multiple time periods."
+}

CHANGELOG.md

@@ -11,39 +11,107 @@ All notable changes to this project will be documented in this file.
 [semver]: https://semver.org/spec/v2.0.0.html
 [pkjjl]: https://pkgdocs.julialang.org/v1/compatibility/#compat-pre-1.0
 
+## [0.7.2] -- 2023-03-10
+
+### Fixed
+
+- Core: Fixed modeling issue with collection disposal
+- Core: Fix column names in products CSV file
+
+## [0.7.1] -- 2023-03-08
+
+### Added
+
+- Core: Add `write_reports` function
+
+### Changed
+
+- Web UI: Disable usage of heuristic method
+
+### Fixed
+
+- Core: Prevent plants from sending products to themselves
+- Core: Enforce constraint that, if plant is closed, storage cannot be used
+- Web UI: Fix parsing bug in disposal limit
+
+## [0.7.0] -- 2023-02-23
+
+### Added
+
+- Core: Allow disposal at collection centers
+- Core: Allow products to have acquisition costs
+- Core: Allow modeling of existing plants
+- Web UI: Allow CSV variables and expressions
+- Web UI: Allow specifying distance metric
+
+### Changed
+
+- Switch from Cbc/Clp to HiGHS
+
+## [0.6.0] -- 2022-12-15
+
+### Added
+
+- Allow RELOG to calculate approximate driving distances, instead of just straight-line distances between points.
+
+### Fixed
+
+- Fix bug that caused building period parameter to be ignored
+
+## [0.5.2] -- 2022-08-26
+
+### Changed
+
+- Update to JuMP 1.x
+
 ## [0.5.1] -- 2021-07-23
-## Added
+
+### Added
+
 - Allow user to specify locations as unique identifiers, instead of latitude and longitude (e.g. `us-state:IL` or `2018-us-county:17043`)
 - Add what-if scenarios.
 - Add products report.
 
 ## [0.5.0] -- 2021-01-06
-## Added
+
+### Added
+
 - Allow plants to store input material for processing in later years
 
 ## [0.4.0] -- 2020-09-18
-## Added
+
+### Added
+
 - Generate simplified solution reports (CSV)
 
 ## [0.3.3] -- 2020-10-13
-## Added
+
+### Added
+
 - Add option to write solution to JSON file in RELOG.solve
 - Improve error message when instance is infeasible
 - Make output file more readable
 
 ## [0.3.2] -- 2020-10-07
-## Added
+
+### Added
+
 - Add "building period" parameter
 
 ## [0.3.1] -- 2020-07-17
-## Fixed
+
+### Fixed
+
 - Fix expansion cost breakdown
 
 ## [0.3.0] -- 2020-06-25
-## Added
+
+### Added
+
 - Track emissions and energy (transportation and plants)
 
-## Changed
+### Changed
+
 - Minor changes to input file format:
-    - Make all dictionary keys lowercase
-    - Rename "outputs (tonne)" to "outputs (tonne/tonne)"
+  - Make all dictionary keys lowercase
+  - Rename "outputs (tonne)" to "outputs (tonne/tonne)"

Dockerfile

@@ -1,5 +1,7 @@
 FROM julia:1.7-buster
 
+ENV RELOG_TIME_LIMIT_SEC=3600
+
 # Install Node.js & zip
 RUN apt-get update -yq && \
     apt-get -yq install curl gnupg ca-certificates && \
@@ -24,4 +26,4 @@ RUN julia --project=/app -e 'using Pkg; Pkg.precompile()'
 RUN cd /app/relog-web && npm run build
 
 WORKDIR /app
-CMD julia --project=/app -e 'import RELOG; RELOG.web("0.0.0.0")'
+CMD julia --project=/app -e 'import RELOG; RELOG.web("0.0.0.0")'

Makefile

@@ -1,32 +1,30 @@
-JULIA := julia --color=yes --project=@.
-SRC_FILES := $(wildcard src/*.jl test/*.jl)
-VERSION := 0.5
-
-all: docs test
-
-build/sysimage.so: src/sysimage.jl Project.toml Manifest.toml
-	mkdir -p build
-	$(JULIA) src/sysimage.jl
-
-build/test.log: $(SRC_FILES) build/sysimage.so
-	cd test; $(JULIA) --sysimage ../build/sysimage.so runtests.jl
+VERSION := 0.7
+PKG := ghcr.io/anl-ceeesa/relog-web
 
 clean:
-	rm -rf build/*
+	rm -rfv build Manifest.toml test/Manifest.toml deps/formatter/build deps/formatter/Manifest.toml
 
 docs:
-	mkdocs build -d ../docs/$(VERSION)/
-
+	rsync -avP --delete-after docs/build/ ../docs/$(VERSION)/
+	
 docker-build:
-	docker build --tag relog:0.6 .
+	docker build --tag $(PKG):$(VERSION) .
+	docker build --tag $(PKG):latest .
+
+docker-push:
+	docker push $(PKG):$(VERSION)
+	docker push $(PKG):latest
+
+docker-run:
+	docker run -it --rm --name relog --volume $(PWD)/jobs:/app/jobs --publish 8000:8080 $(PKG):$(VERSION)
 
 format:
-	julia -e 'using JuliaFormatter; format(["src", "test"], verbose=true);'
+	cd deps/formatter; ../../juliaw format.jl
 
-test: build/test.log
+test: test/Manifest.toml
+	./juliaw test/runtests.jl
 
-test-watch:
-	bash -c "while true; do make test --quiet; sleep 1; done"
-
-.PHONY: docs test
+test/Manifest.toml: test/Project.toml
+	julia --project=test -e "using Pkg; Pkg.instantiate()"
 
+.PHONY: docs test format

Project.toml

@@ -1,13 +1,11 @@
 name = "RELOG"
 uuid = "a2afcdf7-cf04-4913-85f9-c0d81ddf2008"
 authors = ["Alinson S Xavier <axavier@anl.gov>"]
-version = "0.5.1"
+version = "0.7.2"
 
 [deps]
 CRC = "44b605c4-b955-5f2b-9b6d-d2bd01d3d205"
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
-Cbc = "9961bab8-2fa3-5c5a-9d89-47fab24efd76"
-Clp = "e2554f3b-3117-50c0-817c-e040a3ddf72d"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
@@ -15,13 +13,14 @@ Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
 GZip = "92fee26a-97fe-5a0c-ad85-20a5f3185b63"
 Geodesy = "0ef565a4-170c-5f04-8de2-149903a85f3d"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
+HiGHS = "87dc4568-4c63-4d18-b0c0-bb2238e4078b"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 JSONSchema = "7d188eb4-7ad8-530c-ae41-71a32a6d4692"
 JuMP = "4076af6c-e467-56ae-b986-b466b2749572"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
+NearestNeighbors = "b8a86587-4115-5ab1-83bc-aa920d37bbce"
 OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
-PackageCompiler = "9b87118b-4619-50d2-8e1e-99f35a4d4d9d"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 ProgressBars = "49802e3a-d2f1-5c88-81d8-b72133a6f568"
@@ -33,21 +32,20 @@ ZipFile = "a5390f91-8eb1-5f08-bee0-b1d1ffed6cea"
 
 [compat]
 CRC = "4"
-CSV = "0.7"
-Cbc = "0.6"
-Clp = "0.8"
-DataFrames = "0.21"
-DataStructures = "0.17"
+CSV = "0.10"
+DataFrames = "1"
+DataStructures = "0.18"
 GZip = "0.5"
-Geodesy = "0.5"
+Geodesy = "1"
 HTTP = "0.9"
+HiGHS = "1"
 JSON = "0.21"
-JSONSchema = "0.3"
-JuMP = "0.21"
-MathOptInterface = "0.9"
-OrderedCollections = "1.4"
-PackageCompiler = "1"
-ProgressBars = "0.6"
-Shapefile = "0.7"
-ZipFile = "0.9"
+JSONSchema = "1"
+JuMP = "1"
+MathOptInterface = "1"
+NearestNeighbors = "0.4"
+OrderedCollections = "1"
+ProgressBars = "1"
+Shapefile = "0.8"
+ZipFile = "0.10"
 julia = "1"

README.md

@@ -1,7 +1,7 @@
 <h1 align="center">RELOG: Reverse Logistics Optimization</h1>
 <p align="center">
   <a href="https://github.com/ANL-CEEESA/RELOG/actions">
-    <img src="https://github.com/ANL-CEEESA/RELOG/workflows/CI/badge.svg">
+    <img src="https://github.com/ANL-CEEESA/RELOG/workflows/Build%20&%20Test/badge.svg">
   </a>
   <a href="https://doi.org/10.5281/zenodo.4302341">
     <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4302341.svg">
@@ -13,14 +13,14 @@
 
 **RELOG** is a supply chain optimization package focusing on reverse logistics and reverse manufacturing. For example, the package can be used to determine where to build recycling plants, what sizes should they have and which customers should be served by which plants. The package supports customized reverse logistics pipelines, with multiple types of plants, multiple types of product and multiple time periods.
 
-<img src="https://anl-ceeesa.github.io/RELOG/0.5/images/ex_transportation.png" width="1000px"/>
+<img src="https://anl-ceeesa.github.io/RELOG/0.7/assets/ex_transportation.png" width="1000px"/>
 
 ### Documentation
 
-- [Usage](https://anl-ceeesa.github.io/RELOG/0.5/usage)
-- [Input and Output Data Formats](https://anl-ceeesa.github.io/RELOG/0.5/format)
-- [Simplified Solution Reports](https://anl-ceeesa.github.io/RELOG/0.5/reports)
-- [Optimization Model](https://anl-ceeesa.github.io/RELOG/0.5/model)
+- [Usage](https://anl-ceeesa.github.io/RELOG/0.7/usage)
+- [Input and Output Data Formats](https://anl-ceeesa.github.io/RELOG/0.7/format)
+- [Simplified Solution Reports](https://anl-ceeesa.github.io/RELOG/0.7/reports)
+- [Optimization Model](https://anl-ceeesa.github.io/RELOG/0.7/model)
 
 ### Authors
 

docs/Project.toml

@@ -0,0 +1,4 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+RELOG = "a2afcdf7-cf04-4913-85f9-c0d81ddf2008"
+Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"

docs/make.jl

@@ -0,0 +1,17 @@
+using Documenter, RELOG
+
+function make()
+    makedocs(
+        sitename="RELOG",
+        pages=[
+            "Home" => "index.md",
+            "usage.md",
+            "format.md",
+            "reports.md",
+            "model.md",
+        ],
+        format = Documenter.HTML(
+            assets=["assets/custom.css"],
+        )
+    )
+end

docs/src/assets/custom.css

@@ -0,0 +1,36 @@
+@media screen and (min-width: 1056px) {
+    #documenter .docs-main {
+      max-width: 65rem !important;
+    }
+}
+  
+
+tbody, thead, pre {
+    border: 1px solid rgba(0, 0, 0, 0.25);
+}
+
+table td, th {
+    padding: 8px;
+}
+
+table p {
+    margin-bottom: 0;
+}
+
+table td code {
+    white-space: nowrap;
+}
+
+table tr,
+table th {
+    border-bottom: 1px solid rgba(0, 0, 0, 0.1);
+}
+
+table tr:last-child {
+    border-bottom: 0;
+}
+
+code {
+    background-color: transparent;
+    color: rgb(232, 62, 140);
+}

docs/src/format.md

@@ -0,0 +1,239 @@
+# Input and Output Data Formats
+
+In this page, we describe the input and output JSON formats used by RELOG. In addition to these, RELOG can also produce [simplified reports](reports.md) in tabular data format.
+
+## Input Data Format (JSON)
+
+RELOG accepts as input a JSON file with three sections: `parameters`, `products` and `plants`. Below, we describe each section in more detail.
+
+### Parameters
+
+The **parameters** section describes details about the simulation itself.
+
+| Key                       | Description                                                                                                                                                                                                                                                  |
+| :------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `time horizon (years)`    | Number of years in the simulation.                                                                                                                                                                                                                           |
+| `building period (years)` | List of years in which we are allowed to open new plants. For example, if this parameter is set to `[1,2,3]`, we can only open plants during the first three years. By default, this equals `[1]`; that is, plants can only be opened during the first year. |
+| `distance metric`         | Metric used to compute distances between pairs of locations. Valid options are: `"Euclidean"`, for the straight-line distance between points; or `"driving"` for an approximated driving distance. If not specified, defaults to `"Euclidean"`.              |
+
+#### Example
+
+```json
+{
+  "parameters": {
+    "time horizon (years)": 2,
+    "building period (years)": [1],
+    "distance metric": "driving"
+  }
+}
+```
+
+### Products
+
+The **products** section describes all products and subproducts in the simulation. The field `instance["Products"]` is a dictionary mapping the name of the product to a dictionary which describes its characteristics. Each product description contains the following keys:
+
+| Key                                         | Description                                                                                                                                                                                            |
+| :------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `transportation cost ($/km/tonne)`          | The cost to transport this product. Must be a time series.                                                                                                                                             |
+| `transportation energy (J/km/tonne)`        | The energy required to transport this product. Must be a time series. Optional.                                                                                                                        |
+| `transportation emissions (tonne/km/tonne)` | A dictionary mapping the name of each greenhouse gas, produced to transport one tonne of this product along one kilometer, to the amount of gas produced (in tonnes). Must be a time series. Optional. |
+| `initial amounts`                           | A dictionary mapping the name of each location to its description (see below). If this product is not initially available, this key may be omitted. Must be a time series.                             |
+| `disposal limit (tonne)`                    | Total amount of product that can be disposed of across all collection centers. If omitted, all product must be processed. This parameter has no effect on product disposal at plants.                  |
+| `disposal cost ($/tonne)`                   | Cost of disposing one tonne of this product at a collection center. If omitted, defaults to zero. This parameter has no effect on product disposal costs at plants.                                    |
+| `acquisition cost ($/tonne)`                | Cost of acquiring one tonne of this product at a collection center. If omitted, defaults to zero.                                                                                                      |
+
+Each product may have some amount available at the beginning of each time period. In this case, the key `initial amounts` maps to a dictionary with the following keys:
+
+| Key               | Description                                                                           |
+| :---------------- | :------------------------------------------------------------------------------------ |
+| `latitude (deg)`  | The latitude of the location.                                                         |
+| `longitude (deg)` | The longitude of the location.                                                        |
+| `amount (tonne)`  | The amount of the product initially available at the location. Must be a time series. |
+
+#### Example
+
+```json
+{
+  "products": {
+    "P1": {
+      "initial amounts": {
+        "C1": {
+          "latitude (deg)": 7.0,
+          "longitude (deg)": 7.0,
+          "amount (tonne)": [934.56, 934.56]
+        },
+        "C2": {
+          "latitude (deg)": 7.0,
+          "longitude (deg)": 19.0,
+          "amount (tonne)": [198.95, 198.95]
+        },
+        "C3": {
+          "latitude (deg)": 84.0,
+          "longitude (deg)": 76.0,
+          "amount (tonne)": [212.97, 212.97]
+        }
+      },
+      "transportation cost ($/km/tonne)": [0.015, 0.015],
+      "transportation energy (J/km/tonne)": [0.12, 0.11],
+      "transportation emissions (tonne/km/tonne)": {
+        "CO2": [0.052, 0.05],
+        "CH4": [0.003, 0.002]
+      },
+      "disposal cost ($/tonne)": [-10.0, -12.0],
+      "disposal limit (tonne)": [1.0, 1.0],
+      "acquisition cost ($/tonne)": [1.0, 1.0]
+    },
+    "P2": {
+      "transportation cost ($/km/tonne)": [0.022, 0.02]
+    },
+    "P3": {
+      "transportation cost ($/km/tonne)": [0.0125, 0.0125]
+    },
+    "P4": {
+      "transportation cost ($/km/tonne)": [0.0175, 0.0175]
+    }
+  }
+}
+```
+
+### Processing plants
+
+The **plants** section describes the available types of reverse manufacturing plants, their potential locations and associated costs, as well as their inputs and outputs. The field `instance["Plants"]` is a dictionary mapping the name of the plant to a dictionary with the following keys:
+
+| Key                       | Description                                                                                                                                                                                                                                                                                                                 |
+| :------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `input`                   | The name of the product that this plant takes as input. Only one input is accepted per plant.                                                                                                                                                                                                                               |
+| `outputs (tonne/tonne)`   | A dictionary specifying how many tonnes of each product is produced for each tonnes of input. For example, if the plant outputs 0.5 tonnes of P2 and 0.25 tonnes of P3 for each tonnes of P1 provided, then this entry should be `{"P2": 0.5, "P3": 0.25}`. If the plant does not output anything, this key may be omitted. |
+| `energy (GJ/tonne)`       | The energy required to process 1 tonne of the input. Must be a time series. Optional.                                                                                                                                                                                                                                       |
+| `emissions (tonne/tonne)` | A dictionary mapping the name of each greenhouse gas, produced to process each tonne of input, to the amount of gas produced (in tonne). Must be a time series. Optional.                                                                                                                                                   |
+| `locations`               | A dictionary mapping the name of the location to a dictionary which describes the site characteristics (see below).                                                                                                                                                                                                         |
+
+Each type of plant is associated with a set of potential locations where it can be built. Each location is represented by a dictionary with the following keys:
+
+| Key                        | Description                                                                      |
+| :------------------------- | -------------------------------------------------------------------------------- |
+| `latitude (deg)`           | The latitude of the location, in degrees.                                        |
+| `longitude (deg)`          | The longitude of the location, in degrees.                                       |
+| `disposal`                 | A dictionary describing what products can be disposed locally at the plant.      |
+| `storage`                  | A dictionary describing the plant's storage.                                     |
+| `capacities (tonne)`       | A dictionary describing what plant sizes are allowed, and their characteristics. |
+| `initial capacity (tonne)` | Capacity already available at this location. Optional.                           |
+
+The `storage` dictionary should contain the following keys:
+
+| Key              | Description                                                                            |
+| :--------------- | :------------------------------------------------------------------------------------- |
+| `cost ($/tonne)` | The cost to store a tonne of input product for one time period. Must be a time series. |
+| `limit (tonne)`  | The maximum amount of input product this plant can have in storage at any given time.  |
+
+The keys in the `disposal` dictionary should be the names of the products. The values are dictionaries with the following keys:
+
+| Key              | Description                                                                                                                         |
+| :--------------- | :---------------------------------------------------------------------------------------------------------------------------------- |
+| `cost ($/tonne)` | The cost to dispose of the product. Must be a time series.                                                                          |
+| `limit (tonne)`  | The maximum amount that can be disposed of. If an unlimited amount can be disposed, this key may be omitted. Must be a time series. |
+
+The keys in the `capacities (tonne)` dictionary should be the amounts (in tonnes). The values are dictionaries with the following keys:
+
+| Key                                 | Description                                                                                         |
+| :---------------------------------- | :-------------------------------------------------------------------------------------------------- |
+| `opening cost ($)`                  | The cost to open a plant of this size.                                                              |
+| `fixed operating cost ($)`          | The cost to keep the plant open, even if the plant doesn't process anything. Must be a time series. |
+| `variable operating cost ($/tonne)` | The cost that the plant incurs to process each tonne of input. Must be a time series.               |
+
+#### Example
+
+```json
+{
+  "plants": {
+    "F1": {
+      "input": "P1",
+      "outputs (tonne/tonne)": {
+        "P2": 0.2,
+        "P3": 0.5
+      },
+      "energy (GJ/tonne)": [0.12, 0.11],
+      "emissions (tonne/tonne)": {
+        "CO2": [0.052, 0.05],
+        "CH4": [0.003, 0.002]
+      },
+      "locations": {
+        "L1": {
+          "latitude (deg)": 0.0,
+          "longitude (deg)": 0.0,
+          "disposal": {
+            "P2": {
+              "cost ($/tonne)": [-10.0, -12.0],
+              "limit (tonne)": [1.0, 1.0]
+            }
+          },
+          "storage": {
+            "cost ($/tonne)": [5.0, 5.3],
+            "limit (tonne)": 100.0
+          },
+          "capacities (tonne)": {
+            "100": {
+              "opening cost ($)": [500, 530],
+              "fixed operating cost ($)": [300.0, 310.0],
+              "variable operating cost ($/tonne)": [5.0, 5.2]
+            },
+            "500": {
+              "opening cost ($)": [750, 760],
+              "fixed operating cost ($)": [400.0, 450.0],
+              "variable operating cost ($/tonne)": [5.0, 5.2]
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+### Geographic database
+
+Instead of specifying locations using latitudes and longitudes, it is also possible to specify them using unique identifiers, such as the name of a US state, or the county FIPS code. This works anywhere `latitude (deg)` and `longitude (deg)` are expected. For example, instead of:
+
+```json
+{
+  "initial amounts": {
+    "C1": {
+      "latitude (deg)": 37.27182,
+      "longitude (deg)": -119.2704,
+      "amount (tonne)": [934.56, 934.56]
+    }
+  }
+}
+```
+
+is is possible to write:
+
+```json
+{
+  "initial amounts": {
+    "C1": {
+      "location": "us-state:CA",
+      "amount (tonne)": [934.56, 934.56]
+    }
+  }
+}
+```
+
+Location names follow the format `db:id`, where `db` is the name of the database and `id` is the identifier for a specific location. RELOG currently includes the following databases:
+
+| Database         | Description                                                             | Examples                                           |
+| :--------------- | :---------------------------------------------------------------------- | :------------------------------------------------- |
+| `us-state`       | List of states of the United States.                                    | `us-state:IL` (State of Illinois)                  |
+| `2018-us-county` | List of United States counties, as of 2018. IDs are 5-digit FIPS codes. | `2018-us-county:17043` (DuPage county in Illinois) |
+
+### Current limitations
+
+- Each plant can only be opened exactly once. After open, the plant remains open until the end of the simulation.
+- Plants can be expanded at any time, even long after they are open.
+- All material available at the beginning of a time period must be entirely processed by the end of that time period. It is not possible to store unprocessed materials from one time period to the next.
+- Up to two plant sizes are currently supported. Variable operating costs must be the same for all plant sizes.
+- Accurate driving distances are only available for the continental United States.
+
+## Output Data Format (JSON)
+
+To be documented.

docs/src/index.md

@@ -1,25 +1,31 @@
 # RELOG: Reverse Logistics Optimization
 
-
 **RELOG** is an open-source supply chain optimization package focusing on reverse logistics and reverse manufacturing. The package uses Mixed-Integer Linear Programming to determine where to build recycling plants, what size should these plants have and which customers should be served by which plants. The package supports custom reverse logistics pipelines, with multiple types of plants, multiple types of product and multiple time periods.
 
-<img src="images/ex_transportation.png" width="1000px"/>
-
+```@raw html
+<center>
+   <img src="assets/ex_transportation.png" width="1000px"/>
+</center>
+```
 
 ### Table of Contents
 
-  * [Usage](usage.md)
-  * [Input and Output Data Formats](format.md)
-  * [Simplified Solution Reports](reports.md)
-  * [Optimization Model](model.md)
-  
+```@contents
+Pages = ["usage.md", "format.md", "reports.md", "model.md"]
+Depth = 3
+```
+
 ### Source Code
 
-  * [https://github.com/ANL-CEEESA/RELOG](https://github.com/ANL-CEEESA/RELOG)
+- [https://github.com/ANL-CEEESA/RELOG](https://github.com/ANL-CEEESA/RELOG)
 
 ### Authors
-* **Alinson S. Xavier,** Argonne National Laboratory <<axavier@anl.gov>>
-* **Nwike Iloeje,** Argonne National Laboratory <<ciloeje@anl.gov>>
+
+- **Alinson S. Xavier,** Argonne National Laboratory <axavier@anl.gov>
+- **Nwike Iloeje,** Argonne National Laboratory <ciloeje@anl.gov>
+- **John Atkins**
+- **Kyle Sun**
+- **Audrey Gallier**
 
 ### License
 
@@ -48,4 +54,4 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSE
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
-```
+```

docs/src/model.md

@@ -0,0 +1,225 @@
+# Optimization Model
+
+In this page, we describe the precise mathematical optimization model used by RELOG to find the optimal logistics plan. This model is a variation of the classical Facility Location Problem, which has been widely studied in the operations research literature. To simplify the exposition, we present the simplified case where there is only one type of plant.
+
+## Mathematical Description
+
+### Sets
+
+| Symbol                         | Description                                                           |
+| :----------------------------- | :-------------------------------------------------------------------- |
+| $L$                            | Set of collection centers holding the primary material to be recycled |
+| $M$                            | Set of materials recovered during the reverse manufacturing process   |
+| $P$                            | Set of potential plants to open                                       |
+| $T = \{ 1, \ldots, t^{max} \}$ | Set of time periods                                                   |
+
+### Constants
+
+#### Plants
+
+| Symbol                  | Description                                                                            | Unit        |
+| :---------------------- | :------------------------------------------------------------------------------------- | :---------- |
+| $c^\text{exp}_{pt}$     | Cost of adding one tonne of capacity to plant $p$ at time $t$                          | \$/tonne    |
+| $c^\text{f-base}_{pt}$  | Fixed cost of keeping plant $p$ open during time period $t$                            | $           |
+| $c^\text{f-exp}_{pt}$   | Increase in fixed cost for each additional tonne of capacity                           | \$/tonne    |
+| $c^\text{open}_{pt}$    | Cost of opening plant $p$ at time $t$, at minimum capacity                             | $           |
+| $c^\text{p-disp}_{pmt}$ | Cost of disposing recovered material $m$ at plant $p$ during time $t$                  | \$/tonne/km |
+| $c^\text{store}_{pt}$   | Cost of storing primary material at plant $p$ at time $t$                              | \$/tonne    |
+| $c^\text{proc}_{pt}$    | Variable cost of processing primary material at plant $p$ at time $t$                  | \$/tonne    |
+| $m^\text{max}_p$        | Maximum capacity of plant $p$                                                          | tonne       |
+| $m^\text{min}_p$        | Minimum capacity of plant $p$                                                          | tonne       |
+| $m^\text{init}_p$       | Initial capacity of plant $p$                                                          | tonne       |
+| $m^\text{p-disp}_{pmt}$ | Maximum amount of recovered material $m$ that plant $p$ can dispose of during time $t$ | tonne       |
+| $m^\text{store}_p$      | Maximum amount of primary material that plant $p$ can store for later processing.      | tonne       |
+
+#### Products
+
+| Symbol                  | Description                                                                                              | Unit        |
+| :---------------------- | :------------------------------------------------------------------------------------------------------- | :---------- |
+| $\alpha_{pm}$           | Amount of material $m$ recovered by plant $t$ for each tonne of primary material                         | tonne/tonne |
+| $c^\text{acq}_{lt}$     | Cost of acquiring primary material at collection center $l$ during time $t$                              | \$/tonne    |
+| $c^\text{c-disp}_{lt}$  | Cost of disposing primary material at collection center $l$ during time $t$                              | \$/tonne    |
+| $m^\text{c-disp}_{t}$   | Maximum amount of primary material that can be disposed of across all collection centers during time $t$ | tonne       |
+| $m^\text{initial}_{lt}$ | Amount of primary material available to be recycled at collection center $l$ during time $t$             | tonne       |
+
+#### Transportation
+
+| Symbol            | Description                                          | Unit        |
+| :---------------- | :--------------------------------------------------- | :---------- |
+| $c^\text{tr}_{t}$ | Cost to transport primary material during time $t$   | \$/tonne/km |
+| $d_{lp}$          | Distance between plant $p$ and collection center $l$ | km          |
+
+### Decision variables
+
+| Symbol                    | Description                                                                             | Unit    |
+| :------------------------ | :-------------------------------------------------------------------------------------- | :------ |
+| $q_{mpt}$                 | Amount of material $m$ recovered by plant $p$ during time $t$                           | tonne   |
+| $u_{pt}$                  | Binary variable that equals 1 if plant $p$ starts operating at time $t$                 | Boolean |
+| $w_{pt}$                  | Extra capacity (amount above the minimum) added to plant $p$ during time $t$            | tonne   |
+| $x_{pt}$                  | Binary variable that equals 1 if plant $p$ is operational at time $t$                   | Boolean |
+| $y_{lpt}$                 | Amount of primary material sent from collection center $l$ to plant $p$ during time $t$ | tonne   |
+| $z^{\text{p-disp}}_{mpt}$ | Amount of recovered material $m$ disposed of by plant $p$ during time $t$               | tonne   |
+| $z^{\text{c-disp}}_{lt}$  | Amount of primary material disposed of at collection center $l$ during time $t$         | tonne   |
+| $z^{\text{store}}_{pt}$   | Amount of primary material in storage at plant $p$ by the end of time period $t$        | tonne   |
+| $z^{\text{proc}}_{mpt}$   | Amount of primary material processed by plant $p$ during time period $t$                | tonne   |
+
+### Objective function
+
+RELOG minimizes the overall capital, production and transportation costs:
+
+```math
+\begin{align*}
+    \text{minimize} \;\; &
+        \sum_{t \in T} \sum_{p \in P} \left[
+                c^\text{open}_{pt} u_{pt} +
+                c^\text{f-base}_{pt} x_{pt} +
+                c^\text{f-exp}_{pt}  \left( \sum_{i=0}^t w_{pi} \right) +
+                c^{\text{exp}}_{pt} w_{pt}
+            \right] + \\
+    &
+        \sum_{t \in T} \sum_{p \in P} \left[
+                c^{\text{store}}_{pt} z^{\text{store}}_{pt} +
+                c^{\text{proc}}_{pt} z^{\text{proc}}_{pt}
+            \right] + \\
+    &
+        \sum_{t \in T} \sum_{l \in L} \sum_{p \in P}
+            c^{\text{tr}}_t d_{lp} y_{lpt} +
+        \\
+    &
+        \sum_{t \in T} \sum_{p \in P} \sum_{m \in M} c^{\text{p-disp}}_{pmt} z_{pmt} +
+        \\
+    &
+        \sum_{t \in T} \sum_{l \in L} c^\text{acq}_{lt} \left(
+            m^\text{initial}_{lt} - z^{\text{c-disp}}_{lt}
+        \right) + c^\text{c-disp}_{lt} z^{\text{c-disp}}_{lt}
+\end{align*}
+```
+
+In the first line, we have (i) opening costs, if plant starts operating at time $t$, (ii) fixed operating costs, if plant is operational, (iii) additional fixed operating costs coming from expansion performed in all previous time periods up to the current one, and finally (iv) the expansion costs during the current time period.
+In the second line, we have storage and variable processing costs.
+In the third line, we have transportation costs.
+In the fourth line, we have disposal costs at the plants.
+In the fifth line, we have acquisition and disposal cost at the collection centers.
+
+### Constraints
+
+- All primary material must either be sent to a plant for processing or disposed of at the collection center:
+
+```math
+\begin{align*}
+    & \sum_{p \in P} y_{lpt} + z^{\text{c-disp}}_{lt} = m^\text{initial}_{lt}
+        & \forall l \in L, t \in T
+\end{align*}
+```
+
+- There is a limit on how much primary material can be disposed of at the collection centers:
+
+```math
+\begin{align*}
+    & \sum_{l \in L} z^{\text{c-disp}}_{lt} \leq m^\text{c-disp}_{t}
+        & t \in T
+\end{align*}
+```
+
+- Amount received equals amount processed plus stored. Furthermore, all primary material should be processed by the end of the simulation.
+
+```math
+\begin{align*}
+    & \sum_{l \in L} y_{lpt} + z^{\text{store}}_{p,t-1}
+        = z^{\text{proc}}_{pt} + z^{\text{store}}_{p,t}
+        & \forall p \in P, t \in T \\
+    & z^{\text{store}}_{p,0} = 0
+        & \forall p \in P \\
+    & z^{\text{store}}_{p,t^{\max}} = 0
+        & \forall p \in P
+\end{align*}
+```
+
+- Plants have a limited processing capacity. Furthermore, if a plant is closed, it has zero processing capacity:
+
+```math
+\begin{align*}
+    & z^{\text{proc}}_{pt} \leq m^\text{min}_p x_p + \sum_{i=0}^t w_p
+        & \forall p \in P, t \in T
+\end{align*}
+```
+
+- Plants have limited storage capacity. Furthermore, if a plant is closed, is has zero storage capacity:
+
+```math
+\begin{align*}
+    & z^{\text{store}}_{pt} \leq m^\text{store}_p x_p
+        & \forall p \in P, t \in T
+\end{align*}
+```
+
+- Plants can only be expanded up to their maximum capacity. Furthermore, if a plant is closed, it cannot be expanded:
+
+```math
+\begin{align*}
+    & \sum_{i=0}^t w_p \leq \left( m^\text{max}_p - m^\text{min}_p \right) x_p
+        & \forall p \in P, t \in T
+\end{align*}
+```
+
+- Amount of recovered material is proportional to amount processed:
+
+```math
+\begin{align*}
+    & q_{mpt} = \alpha_{pm} z^{\text{proc}}_{pt}
+        & \forall m \in M, p \in P, t \in T
+\end{align*}
+```
+
+- Because we only consider a single type of plant, all recovered material must be immediately disposed of. In RELOG's full model, recovered materials may be sent to another plant for further processing.
+
+```math
+\begin{align*}
+    & q_{mpt} = z^{\text{p-disp}}_{mpt}
+        & \forall m \in M, p \in P, t \in T
+\end{align*}
+```
+
+- A plant is operational at time $t$ if it was operational at time $t-1$ or it was built at time $t$. This constraint also prevents a plant from being built multiple times.
+
+```math
+\begin{align*}
+    & x_{pt} = x_{p,t-1} + u_{pt}
+        & \forall p \in P, t \in T \\
+\end{align*}
+```
+
+- Boundary constants:
+
+```math
+\begin{align*}
+    & x_{p,0} = \begin{cases}
+        0 & \text{ if } m^\text{init}_p = 0 \\
+        1 & \text{ otherwise }
+    \end{cases} \\
+    & w_{p,0} = \max\left\{0, m^\text{init}_p - m^\text{min}_p \right\}
+\end{align*}
+```
+
+- Variable bounds:
+
+```math
+\begin{align*}
+    & q_{mpt} \geq 0
+        & \forall m \in M, p \in P, t \in T \\
+    & u_{pt} \in \{0,1\}
+        & \forall p \in P, t \in T \\
+    & w_{pt} \geq 0
+        & \forall p \in P, t \in T \\
+    & x_{pt} \in \{0,1\}
+        & \forall p \in P, t \in T \\
+    & y_{lpt} \geq 0
+        & \forall l \in L, p \in P, t \in T \\
+    & z^{\text{c-disp}}_{lt} \geq 0
+        & l \in L, t \in T \\
+    & z^{\text{store}}_{pt} \geq 0
+        & p \in P, t \in T \\
+    & z^{\text{p-disp}}_{mpt}, z^{\text{proc}}_{mpt} \geq 0
+        & \forall m \in M, p \in P, t \in T
+\end{align*}
+```

docs/src/reports.md

@@ -9,7 +9,7 @@ In this page, we also illustrate what types of charts and visualizations can be
 Report showing plant costs, capacities, energy expenditure and utilization factors. Generated by `RELOG.write_plants_report(solution, filename)`.
 
 | Column                                | Description
-|:--------------------------------------|---------------|
+|:--------------------------------------|:---------------|
 | `plant type` | Plant type.
 | `location name` | Location name.
 | `year` | What year this row corresponds to. This reports includes one row for each year.
@@ -45,7 +45,9 @@ sns.barplot(x="year",
                      .reset_index());
 ```
 
-<img src="../images/ex_plant_cost_per_year.png" width="500px"/>
+```@raw html
+<img src="../assets/ex_plant_cost_per_year.png" width="500px"/>
+```
 
 * Map showing plant locations (in Python):
 ```python
@@ -65,8 +67,9 @@ points = gp.points_from_xy(data["longitude (deg)"],
 gp.GeoDataFrame(data, geometry=points).plot(ax=ax);
 ```
 
-<img src="../images/ex_plant_locations.png" width="1000px"/>
-
+```@raw html
+<img src="../assets/ex_plant_locations.png" width="1000px"/>
+```
 
 ## Plant outputs report
 
@@ -74,7 +77,7 @@ Report showing amount of products produced, sent and disposed of by each plant,
 
 
 | Column                                | Description
-|:--------------------------------------|---------------|
+|:--------------------------------------|:---------------|
 | `plant type`  | Plant type.
 | `location name`  | Location name.
 | `year`  | What year this row corresponds to. This reports includes one row for each year.
@@ -101,7 +104,9 @@ sns.barplot(x="amount produced (tonne)",
                      .reset_index());
 ```
 
-<img src="../images/ex_amount_produced.png" width="500px"/>
+```@raw html
+<img src="../assets/ex_amount_produced.png" width="500px"/>
+```
 
 
 ## Plant emissions report
@@ -109,7 +114,7 @@ sns.barplot(x="amount produced (tonne)",
 Report showing amount of emissions produced by each plant. Generated by `RELOG.write_plant_emissions_report(solution, filename)`.
 
 | Column                                | Description
-|:--------------------------------------|---------------|
+|:--------------------------------------|:---------------|
 | `plant type` | Plant type.
 | `location name` | Location name.
 | `year` | Year.
@@ -133,20 +138,23 @@ sns.barplot(x="plant type",
                      .reset_index());
 ```
 
-<img src="../images/ex_emissions.png" width="500px"/>
+```@raw html
+<img src="../assets/ex_emissions.png" width="500px"/>
+```
 
 ## Products report
 
 Report showing primary product amounts, locations and marginal costs. Generated by `RELOG.write_products_report(solution, filename)`.
 
 | Column                                | Description
-|:--------------------------------------|---------------|
+|:--------------------------------------|:---------------|
 | `product name`  | Product name.
 | `location name`  | Name of the collection center.
 | `latitude (deg)` | Latitude of the collection center.
 | `longitude (deg)` | Longitude of the collection center.
 | `year`  | What year this row corresponds to. This reports includes one row for each year.
 | `amount (tonne)` | Amount of product available at this collection center.
+| `amount disposed (tonne)` | Amount of product disposed of at this collection center.
 | `marginal cost ($/tonne)` | Cost to process one additional tonne of this product coming from this collection center.
 
 
@@ -156,7 +164,7 @@ Report showing amount of product sent from initial locations to plants, and from
 
 
 | Column                                | Description
-|:--------------------------------------|---------------|
+|:--------------------------------------|:---------------|
 | `source type` | If product is being shipped from an initial location, equals `Origin`. If product is being shipped from a plant, equals plant type.
 | `source location name` | Name of the location where the product is being shipped from.
 | `source latitude (deg)` | Latitude of the source location.
@@ -190,7 +198,9 @@ sns.barplot(x="product",
                      .reset_index());
 ```
 
-<img src="../images/ex_transportation_amount_distance.png" width="500px"/>
+```@raw html
+<img src="../assets/ex_transportation_amount_distance.png" width="500px"/>
+```
 
 * Map of transportation lines (in Python):
 
@@ -233,7 +243,9 @@ gp.GeoDataFrame(data, geometry=points).plot(ax=ax,
                                             markersize=50);
 ```
 
-<img src="../images/ex_transportation.png" width="1000px"/>
+```@raw html
+<img src="../assets/ex_transportation.png" width="1000px"/>
+```
 
 
 ## Transportation emissions report
@@ -241,7 +253,7 @@ gp.GeoDataFrame(data, geometry=points).plot(ax=ax,
 Report showing emissions for each trip between initial locations and plants, and between pairs of plants. Generated by `RELOG.write_transportation_emissions_report(solution, filename)`.
 
 | Column                                | Description
-|:--------------------------------------|---------------|
+|:--------------------------------------|:---------------|
 | `source type` | If product is being shipped from an initial location, equals `Origin`. If product is being shipped from a plant, equals plant type.
 | `source location name` | Name of the location where the product is being shipped from.
 | `source latitude (deg)` | Latitude of the source location.
@@ -275,4 +287,6 @@ sns.barplot(x="emission type",
                      .reset_index());
 ```
 
-<img src="../images/ex_transportation_emissions.png" width="500px"/>
+```@raw html
+<img src="../assets/ex_transportation_emissions.png" width="500px"/>
+```

docs/src/usage.md

@@ -1,24 +1,12 @@
-Usage
-=====
+# Usage
 
 ## 1. Installation
 
-To use RELOG, the first step is to install the [Julia programming language](https://julialang.org/) on your machine. Note that RELOG was developed and tested with Julia 1.5 and may not be compatible with newer versions. After Julia is installed, launch the Julia console, type `]` to switch to package manger mode, then run:
+To use RELOG, the first step is to install the [Julia programming language](https://julialang.org/) on your machine. Note that RELOG was developed and tested with Julia 1.8 and may not be compatible with newer versions. After Julia is installed, launch the Julia console, then run:
 
-```text
-(@v1.5) pkg> add https://github.com/ANL-CEEESA/RELOG.git
-```
-
-After the package and all its dependencies have been installed, please run the RELOG test suite, as shown below, to make sure that the package has been correctly installed:
-
-```text
-(@v1.5) pkg> test RELOG
-```
-
-To update the package to a newer version, type `]` to enter the package manager mode, then run:
-
-```text
-(@v1.5) pkg> update RELOG
+```julia
+using Pkg
+Pkg.add(name="RELOG", version="0.7")
 ```
 
 ## 2. Modeling the problem
@@ -27,21 +15,21 @@ The two main model components in RELOG are **products** and **plants**.
 
 A **product** is any material that needs to be recycled, any intermediary product produced during the recycling process, or any product recovered at the end of the process. For example, in a NiMH battery recycling study case, products could include (i) the original batteries to be recycled; (ii) the cathode and anode parts of the battery; (iii) rare-earth elements and (iv) scrap metals.
 
-* The model assumes that some products are initially available at user-specified locations (described by their latitude, longitude and the amount available), while other products only become available during the recycling process.
+- The model assumes that some products are initially available at user-specified locations (described by their latitude, longitude and the amount available), while other products only become available during the recycling process.
 
-* Products that are initially available must be sent to a plant for processing during the same time period they became available.
+- Products that are initially available must be sent to a plant for processing during the same time period they became available.
 
-* Transporting products from one location to another incurs a transportation cost (`$/km/tonne`), spends some amount of energy (`J/km/tonne`) and may generate multiple types of emissions (`tonne/tonne`). All these parameters are user-specified and may be product- and time-specific.
+- Transporting products from one location to another incurs a transportation cost (`$/km/tonne`), spends some amount of energy (`J/km/tonne`) and may generate multiple types of emissions (`tonne/tonne`). All these parameters are user-specified and may be product- and time-specific.
 
-A **plant** is a facility that converts one type of product to another. RELOG assumes that each plant receives a single type of product as input and converts this input into multiple types of products. Multiple types of plants, with different inputs, outputs and performance characteristics, may be specified. In the NiMH battery recycling study case, for example, one type of plant could be a *disassembly plant*, which converts *batteries* into *cathode* and *anode*. Another type of plant could be *anode recycling plant*, which converts *anode* into *rare-earth elements* and *scrap metals*.
+A **plant** is a facility that converts one type of product to another. RELOG assumes that each plant receives a single type of product as input and converts this input into multiple types of products. Multiple types of plants, with different inputs, outputs and performance characteristics, may be specified. In the NiMH battery recycling study case, for example, one type of plant could be a _disassembly plant_, which converts _batteries_ into _cathode_ and _anode_. Another type of plant could be _anode recycling plant_, which converts _anode_ into _rare-earth elements_ and _scrap metals_.
 
-* To process each tonne of input material, plants incur a variable operating cost (`$/tonne`), spend some amount of energy (`GJ/tonne`), and produce multiple types of emissions (`tonne/tonne`). Plants also incur a fixed operating cost (`$`) regardless of the amount of material they process. All these parameters are user-specified and may be region- and time-specific.
+- To process each tonne of input material, plants incur a variable operating cost (`$/tonne`), spend some amount of energy (`GJ/tonne`), and produce multiple types of emissions (`tonne/tonne`). Plants also incur a fixed operating cost (`$`) regardless of the amount of material they process. All these parameters are user-specified and may be region- and time-specific.
 
-* Plants can be built at user-specified potential locations. Opening a plant incurs a one-time opening cost (`$`) which may be region- and time-specific. Plants also have a limited capacity (in `tonne`), which indicates the maximum amount of input material they are able to process per year. When specifying potential locations for each type of plant, it is also possible to specify the minimum and maximum capacity of the plants that can be built at that particular location. Different plants sizes may have different opening costs and fixed operating costs. After a plant is built, it can be further expanded in the following years, up to its maximum capacity.
+- Plants can be built at user-specified potential locations. Opening a plant incurs a one-time opening cost (`$`) which may be region- and time-specific. Plants also have a limited capacity (in `tonne`), which indicates the maximum amount of input material they are able to process per year. When specifying potential locations for each type of plant, it is also possible to specify the minimum and maximum capacity of the plants that can be built at that particular location. Different plants sizes may have different opening costs and fixed operating costs. After a plant is built, it can be further expanded in the following years, up to its maximum capacity.
 
-* Products received by a plant can be either processed immediately or stored for later processing. Plants have a maximum storage capacity (`tonne`). Storage costs (`$/tonne`) can also be specified.
+- Products received by a plant can be either processed immediately or stored for later processing. Plants have a maximum storage capacity (`tonne`). Storage costs (`$/tonne`) can also be specified.
 
-* All products generated by a plant can either be sent to another plant for further processing, or disposed of locally for either a profit or a loss (`$/tonne`). To model environmental regulations, it is also possible to specify the maximum amount of each product that can be disposed of at each location.
+- All products generated by a plant can either be sent to another plant for further processing, or disposed of locally for either a profit or a loss (`$/tonne`). To model environmental regulations, it is also possible to specify the maximum amount of each product that can be disposed of at each location.
 
 All user parameters specified above must be provided to RELOG as a JSON file, which is fully described in the [data format page](format.md).
 
@@ -101,23 +89,26 @@ To use the `resolve` method, the new input file should be very similar to the or
 - **Plant's storage:** Cost.
 - **Plant's capacity:** Opening cost, fixed operating cost and variable operating cost.
 
-
 ## 5. Advanced options
 
 ### 5.1 Changing the solver
 
-By default, RELOG internally uses [Cbc](https://github.com/coin-or/Cbc), an open-source and freely-available Mixed-Integer Linear Programming solver developed by the [COIN-OR Project](https://www.coin-or.org/). For larger-scale test cases, a commercial solver such as Gurobi, CPLEX or XPRESS is recommended. The following snippet shows how to switch from Cbc to Gurobi, for example:
+By default, RELOG internally uses [HiGHS](https://github.com/ERGO-Code/HiGHS), an open-source and freely-available Mixed-Integer Linear Programming solver. For larger-scale test cases, a commercial solver such as Gurobi, CPLEX or XPRESS is recommended. The following snippet shows how to switch to Gurobi, for example:
 
 ```julia
 using RELOG, Gurobi, JuMP
 
-gurobi = optimizer_with_attributes(Gurobi.Optimizer,
-                                   "TimeLimit" => 3600,
-                                   "MIPGap" => 0.001)
+gurobi = optimizer_with_attributes(
+    Gurobi.Optimizer,
+    "TimeLimit" => 3600,
+    "MIPGap" => 0.001,
+)
 
-RELOG.solve("instance.json",
-            output="solution.json",
-            optimizer=gurobi)
+RELOG.solve(
+    "instance.json",
+    output="solution.json",
+    optimizer=gurobi,
+)
 ```
 
 ### 5.2 Multi-period heuristics
@@ -133,6 +124,8 @@ To solve an instance using this heuristic, use the option `heuristic=true`, as s
 ```julia
 using RELOG
 
-solution = RELOG.solve("/home/user/instance.json",
-                       heuristic=true)
+solution = RELOG.solve(
+    "/home/user/instance.json",
+    heuristic=true,
+)
 ```

instances/s1.json

@@ -1,202 +0,0 @@
-{
-    "parameters": {
-        "time horizon (years)": 2
-    },
-    "products": {
-        "P1": {
-            "transportation cost ($/km/tonne)": [0.015, 0.015],
-            "transportation energy (J/km/tonne)": [0.12, 0.11],
-            "transportation emissions (tonne/km/tonne)": {
-                "CO2": [0.052, 0.050],
-                "CH4": [0.003, 0.002]
-            },            
-            "initial amounts": {
-                "C1": {
-                    "latitude (deg)": 7.0,
-                    "longitude (deg)": 7.0,
-                    "amount (tonne)": [934.56, 934.56]
-                },
-                "C2": {
-                    "latitude (deg)": 7.0,
-                    "longitude (deg)": 19.0,
-                    "amount (tonne)": [198.95, 198.95]
-                },
-                "C3": {
-                    "latitude (deg)": 84.0,
-                    "longitude (deg)": 76.0,
-                    "amount (tonne)": [212.97, 212.97]
-                },
-                "C4": {
-                    "latitude (deg)": 21.0,
-                    "longitude (deg)": 16.0,
-                    "amount (tonne)": [352.19, 352.19]
-                },
-                "C5": {
-                    "latitude (deg)": 32.0,
-                    "longitude (deg)": 92.0,
-                    "amount (tonne)": [510.33, 510.33]
-                },
-                "C6": {
-                    "latitude (deg)": 14.0,
-                    "longitude (deg)": 62.0,
-                    "amount (tonne)": [471.66, 471.66]
-                },
-                "C7": {
-                    "latitude (deg)": 30.0,
-                    "longitude (deg)": 83.0,
-                    "amount (tonne)": [785.21, 785.21]
-                },
-                "C8": {
-                    "latitude (deg)": 35.0,
-                    "longitude (deg)": 40.0,
-                    "amount (tonne)": [706.17, 706.17]
-                },
-                "C9": {
-                    "latitude (deg)": 74.0,
-                    "longitude (deg)": 52.0,
-                    "amount (tonne)": [30.08, 30.08]
-                },
-                "C10": {
-                    "latitude (deg)": 22.0,
-                    "longitude (deg)": 54.0,
-                    "amount (tonne)": [536.52, 536.52]
-                }
-            }
-        },
-        "P2": {
-            "transportation cost ($/km/tonne)": [0.02, 0.02]
-        },
-        "P3": {
-            "transportation cost ($/km/tonne)": [0.0125, 0.0125]
-        },
-        "P4": {
-            "transportation cost ($/km/tonne)": [0.0175, 0.0175]
-        }
-    },
-    "plants": {
-        "F1": {
-            "input": "P1",
-            "outputs (tonne/tonne)": {
-                "P2": 0.2,
-                "P3": 0.5
-            },
-            "energy (GJ/tonne)": [0.12, 0.11],
-            "emissions (tonne/tonne)": {
-                "CO2": [0.052, 0.050],
-                "CH4": [0.003, 0.002]
-            },            
-            "locations": {
-                "L1": {
-                    "latitude (deg)": 0.0,
-                    "longitude (deg)": 0.0,
-                    "disposal": {
-                        "P2": {
-                            "cost ($/tonne)": [-10.0, -10.0],
-                            "limit (tonne)": [1.0, 1.0]
-                        },
-                        "P3": {
-                            "cost ($/tonne)": [-10.0, -10.0],
-                            "limit (tonne)": [1.0, 1.0]
-                        }
-                    },
-                    "capacities (tonne)": {
-                        "250.0": {
-                            "opening cost ($)": [500.0, 500.0],
-                            "fixed operating cost ($)": [30.0, 30.0],
-                            "variable operating cost ($/tonne)": [30.0, 30.0]
-                        },
-                        "1000.0": {
-                            "opening cost ($)": [1250.0, 1250.0],
-                            "fixed operating cost ($)": [30.0, 30.0],
-                            "variable operating cost ($/tonne)": [30.0, 30.0]
-                        }
-                    }
-                },
-                "L2": {
-                    "latitude (deg)": 0.5,
-                    "longitude (deg)": 0.5,
-                    "capacities (tonne)": {
-                        "0.0": {
-                            "opening cost ($)": [1000, 1000],
-                            "fixed operating cost ($)": [50.0, 50.0],
-                            "variable operating cost ($/tonne)": [50.0, 50.0]
-                        },
-                        "10000.0": {
-                            "opening cost ($)": [10000, 10000],
-                            "fixed operating cost ($)": [50.0, 50.0],
-                            "variable operating cost ($/tonne)": [50.0, 50.0]
-                        }
-                    }
-                }               
-            }
-        },
-        "F2": {
-            "input": "P2",
-            "outputs (tonne/tonne)": {
-                "P3": 0.05,
-                "P4": 0.80
-            },
-            "locations": {
-                "L3": {
-                    "latitude (deg)": 25.0,
-                    "longitude (deg)": 65.0,
-                    "disposal": {
-                        "P3": {
-                            "cost ($/tonne)": [100.0, 100.0]
-                        }
-                    },
-                    "capacities (tonne)": {
-                        "1000.0": {
-                            "opening cost ($)": [3000, 3000],
-                            "fixed operating cost ($)": [50.0, 50.0],
-                            "variable operating cost ($/tonne)": [50.0, 50.0]
-                        }
-                    }
-                },
-                "L4": {
-                    "latitude (deg)": 0.75,
-                    "longitude (deg)": 0.20,
-                    "capacities (tonne)": {
-                        "10000": {
-                            "opening cost ($)": [3000, 3000],
-                            "fixed operating cost ($)": [50.0, 50.0],
-                            "variable operating cost ($/tonne)": [50.0, 50.0]
-                        }
-                    }
-                }
-            }
-        },
-        "F3": {
-            "input": "P4",
-            "locations": {
-                "L5": {
-                    "latitude (deg)": 100.0,
-                    "longitude (deg)": 100.0,
-                    "capacities (tonne)": {
-                        "15000": {
-                            "opening cost ($)": [0.0, 0.0],
-                            "fixed operating cost ($)": [0.0, 0.0],
-                            "variable operating cost ($/tonne)": [-15.0, -15.0]
-                        }
-                    }
-                }           
-            }
-        },
-        "F4": {
-            "input": "P3",
-            "locations": {
-                "L6": {
-                    "latitude (deg)": 50.0,
-                    "longitude (deg)": 50.0,
-                    "capacities (tonne)": {
-                        "10000": {
-                            "opening cost ($)": [0.0, 0.0],
-                            "fixed operating cost ($)": [0.0, 0.0],
-                            "variable operating cost ($/tonne)": [-15.0, -15.0]
-                        }
-                    }
-                }           
-            }
-        }
-    }
-}

mkdocs.yml

@@ -1,23 +0,0 @@
-site_name: RELOG
-theme: cinder
-copyright: "Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved."
-repo_url: https://github.com/ANL-CEEESA/RELOG
-edit_uri: edit/master/src/docs/
-nav:
-    - Home: index.md
-    - Usage: usage.md
-    - Data Format: format.md
-    - Reports: reports.md
-    - Optimization Model: model.md
-plugins:
-  - search
-markdown_extensions:
-  - admonition  
-  - mdx_math  
-extra_javascript: 
-    - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML
-    - js/mathjax.js
-docs_dir: src/docs
-site_dir: docs
-extra_css:
-    - "css/custom.css"

relog-web/package-lock.json

@@ -16,6 +16,7 @@
         "d3-array": "^2.12.1",
         "dagre": "^0.8.5",
         "idb": "^6.1.5",
+        "jsep": "^1.3.8",
         "leaflet": "^1.8.0",
         "react": "^17.0.2",
         "react-dom": "^17.0.2",
@@ -11201,6 +11202,14 @@
         }
       }
     },
+    "node_modules/jsep": {
+      "version": "1.3.8",
+      "resolved": "https://registry.npmjs.org/jsep/-/jsep-1.3.8.tgz",
+      "integrity": "sha512-qofGylTGgYj9gZFsHuyWAN4jr35eJ66qJCK4eKDnldohuUoQFbU3iZn2zjvEbd9wOAhP9Wx5DsAAduTyE1PSWQ==",
+      "engines": {
+        "node": ">= 10.16.0"
+      }
+    },
     "node_modules/jsesc": {
       "version": "2.5.2",
       "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz",
@@ -25021,6 +25030,11 @@
         "xml-name-validator": "^3.0.0"
       }
     },
+    "jsep": {
+      "version": "1.3.8",
+      "resolved": "https://registry.npmjs.org/jsep/-/jsep-1.3.8.tgz",
+      "integrity": "sha512-qofGylTGgYj9gZFsHuyWAN4jr35eJ66qJCK4eKDnldohuUoQFbU3iZn2zjvEbd9wOAhP9Wx5DsAAduTyE1PSWQ=="
+    },
     "jsesc": {
       "version": "2.5.2",
       "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz",

relog-web/package.json

@@ -17,6 +17,7 @@
     "d3-array": "^2.12.1",
     "dagre": "^0.8.5",
     "idb": "^6.1.5",
+    "jsep": "^1.3.8",
     "leaflet": "^1.8.0",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",

relog-web/src/casebuilder/InputPage.js

@@ -235,7 +235,7 @@ const InputPage = () => {
         "disposal limit (tonne)",
       ].forEach((key) => {
         newData.plants[plantName][key] = { ...newData.plants[plantName][key] };
-        newData.plants[plantName][key][productName] = 0;
+        newData.plants[plantName][key][productName] = "0";
       });
       save(newData);
       return newData;
@@ -267,7 +267,12 @@ const InputPage = () => {
     const parsed = JSON.parse(contents);
     const valid = validate(parsed);
     if (valid) {
-      const newData = importData(parsed);
+      let newData = null;
+      if (parsed["case builder"]) {
+        newData = parsed["case builder"];
+      } else {
+        newData = importData(parsed);
+      }
       setData(newData);
       save(newData);
     } else {

relog-web/src/casebuilder/ParametersBlock.js

@@ -37,6 +37,13 @@ const ParametersBlock = (props) => {
             onChange={(v) => onChangeField("inflation rate (%)", v)}
             validate="float"
           />
+          <TextInputRow
+            label="Distance metric"
+            tooltip="Metric used to compute distances between pairs of locations. Valid options are: 'Euclidean', for the straight-line distance between points; or 'driving' for an approximated driving distance."
+            value={props.value["distance metric"]}
+            onChange={(v) => onChangeField("distance metric", v)}
+            default="Euclidean"
+          />
         </Form>
       </Card>
     </>

relog-web/src/casebuilder/PlantBlock.js

@@ -27,24 +27,28 @@ const PlantBlock = (props) => {
           name: "Washakie County",
           "latitude (deg)": "43.8356",
           "longitude (deg)": "-107.6602",
+          "initial capacity (tonne)": "0",
           "area cost factor": "0.88",
         },
         {
           name: "Platte County",
           "latitude (deg)": "42.1314",
           "longitude (deg)": "-104.9676",
+          "initial capacity (tonne)": "0",
           "area cost factor": "1.29",
         },
         {
           name: "Park County",
           "latitude (deg)": "44.4063",
           "longitude (deg)": "-109.4153",
+          "initial capacity (tonne)": "0",
           "area cost factor": "0.99",
         },
         {
           name: "Goshen County",
           "latitude (deg)": "42.0853",
           "longitude (deg)": "-104.3534",
+          "initial capacity (tonne)": "0",
           "area cost factor": "1",
         },
       ])
@@ -59,15 +63,13 @@ const PlantBlock = (props) => {
         "latitude (deg)",
         "longitude (deg)",
         "area cost factor",
+        "initial capacity (tonne)",
       ],
     });
     const result = {};
     data.forEach((el) => {
-      result[el["name"]] = {
-        "latitude (deg)": el["latitude (deg)"],
-        "longitude (deg)": el["longitude (deg)"],
-        "area cost factor": el["area cost factor"],
-      };
+      let { name, ...props } = el;
+      result[name] = props;
     });
     onChange(result, "locations");
   };
@@ -79,9 +81,7 @@ const PlantBlock = (props) => {
     )) {
       result.push({
         name: locationName,
-        "latitude (deg)": locationDict["latitude (deg)"],
-        "longitude (deg)": locationDict["longitude (deg)"],
-        "area cost factor": locationDict["area cost factor"],
+        ...locationDict,
       });
     }
     generateFile(`Candidate locations - ${props.name}.csv`, csvFormat(result));
@@ -129,7 +129,6 @@ const PlantBlock = (props) => {
             value={props.value["outputs (tonne/tonne)"]}
             onChange={(v) => onChange(v, "outputs (tonne/tonne)")}
             disableKeys={true}
-            validate="float"
           />
 
           <h1>Capacity & Costs</h1>
@@ -139,7 +138,6 @@ const PlantBlock = (props) => {
             tooltip="The minimum size of the plant."
             value={props.value["minimum capacity (tonne)"]}
             onChange={(v) => onChange(v, "minimum capacity (tonne)")}
-            validate="float"
           />
           <TextInputRow
             label="Opening cost (min capacity)"
@@ -147,7 +145,6 @@ const PlantBlock = (props) => {
             tooltip="The cost to open the plant at minimum capacity."
             value={props.value["opening cost (min capacity) ($)"]}
             onChange={(v) => onChange(v, "opening cost (min capacity) ($)")}
-            validate="float"
           />
           <TextInputRow
             label="Fixed operating cost (min capacity)"
@@ -157,7 +154,6 @@ const PlantBlock = (props) => {
             onChange={(v) =>
               onChange(v, "fixed operating cost (min capacity) ($)")
             }
-            validate="float"
           />
           <TextInputRow
             label="Maximum capacity"
@@ -165,7 +161,6 @@ const PlantBlock = (props) => {
             tooltip="The maximum size of the plant."
             value={props.value["maximum capacity (tonne)"]}
             onChange={(v) => onChange(v, "maximum capacity (tonne)")}
-            validate="float"
           />
           <TextInputRow
             label="Opening cost (max capacity)"
@@ -177,7 +172,6 @@ const PlantBlock = (props) => {
                 : props.value["opening cost (max capacity) ($)"]
             }
             onChange={(v) => onChange(v, "opening cost (max capacity) ($)")}
-            validate="float"
             disabled={shouldDisableMaxCap}
           />
           <TextInputRow
@@ -192,7 +186,6 @@ const PlantBlock = (props) => {
             onChange={(v) =>
               onChange(v, "fixed operating cost (max capacity) ($)")
             }
-            validate="float"
             disabled={shouldDisableMaxCap}
           />
           <TextInputRow
@@ -201,7 +194,6 @@ const PlantBlock = (props) => {
             tooltip="The cost that the plant incurs to process each tonne of input."
             value={props.value["variable operating cost ($/tonne)"]}
             onChange={(v) => onChange(v, "variable operating cost ($/tonne)")}
-            validate="float"
           />
           <TextInputRow
             label="Energy expenditure"
@@ -209,7 +201,6 @@ const PlantBlock = (props) => {
             tooltip="The energy required to process one tonne of the input."
             value={props.value["energy (GJ/tonne)"]}
             onChange={(v) => onChange(v, "energy (GJ/tonne)")}
-            validate="float"
           />
 
           <h1>Storage</h1>
@@ -219,7 +210,6 @@ const PlantBlock = (props) => {
             tooltip="The cost to store a tonne of input product for one time period."
             value={props.value["storage"]["cost ($/tonne)"]}
             onChange={(v) => onChange(v, "storage", "cost ($/tonne)")}
-            validate="float"
           />
           <TextInputRow
             label="Storage limit"
@@ -227,7 +217,6 @@ const PlantBlock = (props) => {
             tooltip="The maximum amount of input product this plant can have in storage at any given time."
             value={props.value["storage"]["limit (tonne)"]}
             onChange={(v) => onChange(v, "storage", "limit (tonne)")}
-            validate="float"
           />
 
           <h1>Disposal</h1>
@@ -238,7 +227,6 @@ const PlantBlock = (props) => {
             value={props.value["disposal cost ($/tonne)"]}
             onChange={(v) => onChange(v, "disposal cost ($/tonne)")}
             disableKeys={true}
-            validate="float"
           />
           <DictInputRow
             label="Disposal limit"
@@ -248,7 +236,6 @@ const PlantBlock = (props) => {
             onChange={(v) => onChange(v, "disposal limit (tonne)")}
             disableKeys={true}
             valuePlaceholder="Unlimited"
-            validate="float"
           />
 
           <h1>Emissions</h1>
@@ -260,7 +247,6 @@ const PlantBlock = (props) => {
             onChange={(v) => onChange(v, "emissions (tonne/tonne)")}
             keyPlaceholder="Emission name"
             valuePlaceholder="0"
-            validate="float"
           />
         </Form>
       </Card>

relog-web/src/casebuilder/ProductBlock.js

@@ -118,9 +118,17 @@ const ProductBlock = (props) => {
           />
 
           <h1 style={{ display: nCenters == 0 ? "none" : "block" }}>
-            Disposal
+            Acquisition & disposal
           </h1>
           <div style={{ display: nCenters == 0 ? "none" : "block" }}>
+            <TextInputRow
+              label="Acquisition cost"
+              unit="$/tonne"
+              tooltip="Cost of acquiring one tonne of this product at a collection center."
+              value={props.value["acquisition cost ($/tonne)"]}
+              onChange={(v) => onChange("acquisition cost ($/tonne)", v)}
+              validate="floatList"
+            />
             <TextInputRow
               label="Disposal cost"
               unit="$/tonne"

relog-web/src/casebuilder/csv.test.js

@@ -49,5 +49,5 @@ test("generate CSV", () => {
 test("export value", () => {
   expect(exportValue("1")).toEqual(1);
   expect(exportValue("[1,2,3]")).toEqual([1, 2, 3]);
-  expect(exportValue("qwe")).toEqual("qwe");
+  // expect(exportValue("qwe")).toEqual("qwe");
 });

relog-web/src/casebuilder/defaults.js

@@ -1,5 +1,6 @@
 export const defaultProduct = {
   "initial amounts": {},
+  "acquisition cost ($/tonne)": "0",
   "disposal cost ($/tonne)": "0",
   "disposal limit (tonne)": "0",
   "disposal limit (%)": "",
@@ -12,6 +13,7 @@ export const defaultProduct = {
 
 export const defaultPlantLocation = {
   "area cost factor": 1.0,
+  "initial capacity (tonne)": 0,
   "latitude (deg)": 0,
   "longitude (deg)": 0,
 };
@@ -23,17 +25,17 @@ export const defaultPlant = {
   "disposal limit (tonne)": {},
   "emissions (tonne/tonne)": {},
   storage: {
-    "cost ($/tonne)": 0,
-    "limit (tonne)": 0,
+    "cost ($/tonne)": "0",
+    "limit (tonne)": "0",
   },
-  "maximum capacity (tonne)": 0,
-  "minimum capacity (tonne)": 0,
-  "opening cost (max capacity) ($)": 0,
-  "opening cost (min capacity) ($)": 0,
-  "fixed operating cost (max capacity) ($)": 0,
-  "fixed operating cost (min capacity) ($)": 0,
-  "variable operating cost ($/tonne)": 0,
-  "energy (GJ/tonne)": 0,
+  "maximum capacity (tonne)": "0",
+  "minimum capacity (tonne)": "0",
+  "opening cost (max capacity) ($)": "0",
+  "opening cost (min capacity) ($)": "0",
+  "fixed operating cost (max capacity) ($)": "0",
+  "fixed operating cost (min capacity) ($)": "0",
+  "variable operating cost ($/tonne)": "0",
+  "energy (GJ/tonne)": "0",
   x: 0,
   y: 0,
 };
@@ -43,6 +45,7 @@ export const defaultData = {
     "time horizon (years)": "1",
     "building period (years)": "[1]",
     "inflation rate (%)": "0",
+    "distance metric": "Euclidean",
   },
   products: {},
   plants: {},

relog-web/src/casebuilder/export.js

@@ -1,3 +1,5 @@
+import { evaluateExpr } from "./expr";
+
 const isNumeric = (val) => {
   return String(val).length > 0 && !isNaN(val);
 };
@@ -10,10 +12,10 @@ const keysToList = (obj) => {
   return result;
 };
 
-export const exportValue = (original, T, R = 1) => {
-  if (isNumeric(original)) {
+export const exportValue = (original, T, R = 1, data = {}) => {
+  try {
     if (T) {
-      let v = parseFloat(original);
+      let v = evaluateExpr(original.toString(), data);
       const result = [];
       for (let i = 0; i < T; i++) {
         result.push(v);
@@ -21,8 +23,10 @@ export const exportValue = (original, T, R = 1) => {
       }
       return result;
     } else {
-      return parseFloat(original);
+      return evaluateExpr(original.toString(), data);
     }
+  } catch {
+    // ignore;
   }
 
   try {
@@ -31,6 +35,7 @@ export const exportValue = (original, T, R = 1) => {
   } catch {
     // ignore
   }
+
   return original;
 };
 
@@ -139,12 +144,14 @@ export const exportProduct = (original, parameters) => {
   );
 
   // Copy cost time series (with inflation)
-  ["disposal cost ($/tonne)", "transportation cost ($/km/tonne)"].forEach(
-    (key) => {
-      const v = exportValue(original[key], T, R);
-      if (v.length > 0) result[key] = v;
-    }
-  );
+  [
+    "disposal cost ($/tonne)",
+    "acquisition cost ($/tonne)",
+    "transportation cost ($/km/tonne)",
+  ].forEach((key) => {
+    const v = exportValue(original[key], T, R);
+    if (v.length > 0) result[key] = v;
+  });
 
   // Copy dictionaries
   ["transportation emissions (tonne/km/tonne)"].forEach((key) => {
@@ -197,18 +204,28 @@ export const exportPlant = (original, parameters) => {
     if (v) result[key] = v;
   });
 
-  const minCap = original["minimum capacity (tonne)"];
-  const maxCap = original["maximum capacity (tonne)"];
-
   result.locations = {};
   for (const [locName, origDict] of Object.entries(original["locations"])) {
+    const minCap = exportValue(
+      original["minimum capacity (tonne)"],
+      null,
+      null,
+      origDict
+    );
+    const maxCap = exportValue(
+      original["maximum capacity (tonne)"],
+      null,
+      null,
+      origDict
+    );
+
     const resDict = (result.locations[locName] = {});
     const capDict = (resDict["capacities (tonne)"] = {});
 
     const acf = origDict["area cost factor"];
 
-    const exportValueAcf = (obj) => {
-      const v = exportValue(obj, T, R);
+    const exportValueAcf = (obj, data = {}) => {
+      const v = exportValue(obj, T, R, data);
       if (Array.isArray(v)) {
         return v.map((v) => v * acf);
       }
@@ -216,9 +233,11 @@ export const exportPlant = (original, parameters) => {
     };
 
     // Copy scalar values
-    ["latitude (deg)", "longitude (deg)"].forEach((key) => {
-      resDict[key] = origDict[key];
-    });
+    ["latitude (deg)", "longitude (deg)", "initial capacity (tonne)"].forEach(
+      (key) => {
+        resDict[key] = origDict[key];
+      }
+    );
 
     // Copy minimum capacity dict
     capDict[minCap] = {};
@@ -227,7 +246,10 @@ export const exportPlant = (original, parameters) => {
       "fixed operating cost ($)": "fixed operating cost (min capacity) ($)",
       "variable operating cost ($/tonne)": "variable operating cost ($/tonne)",
     })) {
-      capDict[minCap][resKeyName] = exportValueAcf(original[origKeyName]);
+      capDict[minCap][resKeyName] = exportValueAcf(
+        original[origKeyName],
+        origDict
+      );
     }
 
     if (maxCap !== minCap) {
@@ -239,7 +261,10 @@ export const exportPlant = (original, parameters) => {
         "variable operating cost ($/tonne)":
           "variable operating cost ($/tonne)",
       })) {
-        capDict[maxCap][resKeyName] = exportValueAcf(original[origKeyName]);
+        capDict[maxCap][resKeyName] = exportValueAcf(
+          original[origKeyName],
+          origDict
+        );
       }
     }
 
@@ -249,23 +274,36 @@ export const exportPlant = (original, parameters) => {
       original["disposal cost ($/tonne)"]
     )) {
       if (dispName.length === 0) continue;
-      const v = exportValueAcf(dispCost, T);
+      const v = exportValueAcf(dispCost, origDict);
       if (v) {
         resDict.disposal[dispName] = { "cost ($/tonne)": v };
-        const limit = original["disposal limit (tonne)"][dispName];
-        if (isNumeric(limit)) {
-          resDict.disposal[dispName]["limit (tonne)"] = exportValue(limit, T);
+        const limit = String(original["disposal limit (tonne)"][dispName]);
+        if (limit.length > 0) {
+          resDict.disposal[dispName]["limit (tonne)"] = exportValue(
+            limit,
+            T,
+            1,
+            origDict
+          );
         }
       }
     }
 
     // Copy storage
     resDict.storage = {
-      "cost ($/tonne)": exportValueAcf(original["storage"]["cost ($/tonne)"]),
+      "cost ($/tonne)": exportValueAcf(
+        original["storage"]["cost ($/tonne)"],
+        origDict
+      ),
     };
     const storLimit = original["storage"]["limit (tonne)"];
-    if (isNumeric(storLimit)) {
-      resDict.storage["limit (tonne)"] = exportValue(storLimit);
+    if (storLimit.length > 0) {
+      resDict.storage["limit (tonne)"] = exportValue(
+        storLimit,
+        null,
+        1,
+        origDict
+      );
     }
   }
 
@@ -283,6 +321,14 @@ export const exportData = (original) => {
   ["time horizon (years)", "building period (years)"].forEach((key) => {
     result.parameters[key] = exportValue(original.parameters[key]);
   });
+  ["distance metric"].forEach((key) => {
+    if (original.parameters[key].length > 0) {
+      result.parameters[key] = original.parameters[key];
+    }
+  });
+
+  console.log(original.parameters);
+  console.log(result.parameters);
 
   // Read time horizon
   let T = result.parameters["time horizon (years)"];
@@ -297,6 +343,10 @@ export const exportData = (original) => {
   for (const [plantName, plantDict] of Object.entries(original.plants)) {
     result.plants[plantName] = exportPlant(plantDict, original.parameters);
   }
+
+  // Export original data
+  result["case builder"] = original;
+
   return result;
 };
 
@@ -344,16 +394,19 @@ export const importProduct = (original) => {
   const [R, T] = computeInflationAndTimeHorizon(original, [
     "transportation cost ($/km/tonne)",
     "disposal cost ($/tonne)",
+    "acquisition cost ($/tonne)",
   ]);
   parameters["inflation rate (%)"] = String((R - 1) * 100);
   parameters["time horizon (years)"] = String(T);
 
   // Import cost lists
-  ["transportation cost ($/km/tonne)", "disposal cost ($/tonne)"].forEach(
-    (key) => {
-      prod[key] = importList(original[key], R);
-    }
-  );
+  [
+    "transportation cost ($/km/tonne)",
+    "disposal cost ($/tonne)",
+    "acquisition cost ($/tonne)",
+  ].forEach((key) => {
+    prod[key] = importList(original[key], R);
+  });
 
   // Import dicts
   ["transportation emissions (tonne/km/tonne)"].forEach((key) => {
@@ -381,6 +434,11 @@ export const importPlant = (original) => {
     plant[key] = null;
   });
 
+  // Initialize defaults
+  if (!original["outputs (tonne/tonne)"]) {
+    original["outputs (tonne/tonne)"] = {};
+  }
+
   // Import scalar values
   ["input"].forEach((key) => {
     plant[key] = original[key];
@@ -400,17 +458,18 @@ export const importPlant = (original) => {
   });
 
   let costsInitialized = false;
-  let R = null;
 
   // Read locations
   const resLocDict = (plant.locations = {});
   for (const [locName, origLocDict] of Object.entries(original["locations"])) {
     resLocDict[locName] = {};
 
-    // Import latitude and longitude
-    ["latitude (deg)", "longitude (deg)"].forEach((key) => {
-      resLocDict[locName][key] = origLocDict[key];
-    });
+    // Import scalars
+    ["latitude (deg)", "longitude (deg)", "initial capacity (tonne)"].forEach(
+      (key) => {
+        resLocDict[locName][key] = origLocDict[key];
+      }
+    );
 
     const capacities = keysToList(origLocDict["capacities (tonne)"]);
     const last = capacities.length - 1;
@@ -449,6 +508,14 @@ export const importPlant = (original) => {
     parameters["inflation rate (%)"] = String((R - 1) * 100);
     parameters["time horizon (years)"] = String(T);
 
+    // Initialize defaults
+    if (!origLocDict.storage) {
+      origLocDict.storage = {
+        "cost ($/tonne)": new Array(T).fill(0),
+        "limit (tonne)": new Array(T).fill(0),
+      };
+    }
+
     // Read adjusted costs
     const importListAcf = (obj) =>
       importList(
@@ -533,6 +600,9 @@ export const importData = (original) => {
   ["building period (years)"].forEach((k) => {
     result.parameters[k] = JSON.stringify(original.parameters[k]);
   });
+  ["distance metric"].forEach((k) => {
+    result.parameters[k] = original.parameters[k];
+  });
   result.parameters["inflation rate (%)"] = "0";
 
   // Import products

relog-web/src/casebuilder/export.test.js

@@ -27,6 +27,7 @@ const sampleProductsOriginal = [
         "amount (tonne)": [100, 200, 300],
       },
     },
+    "acquisition cost ($/tonne)": "4",
     "disposal cost ($/tonne)": "50",
     "disposal limit (tonne)": "30",
     "disposal limit (%)": "",
@@ -57,6 +58,7 @@ const sampleProductsOriginal = [
         "amount (tonne)": [100, 200, 300],
       },
     },
+    "acquisition cost ($/tonne)": "4",
     "disposal cost ($/tonne)": "50",
     "disposal limit (tonne)": "",
     "disposal limit (%)": "10",
@@ -87,6 +89,7 @@ const sampleProductsOriginal = [
         "amount (tonne)": [100, 200, 300],
       },
     },
+    "acquisition cost ($/tonne)": "4",
     "disposal cost ($/tonne)": "50",
     "disposal limit (tonne)": "",
     "disposal limit (%)": "",
@@ -118,6 +121,7 @@ const sampleProductsExported = [
         "amount (tonne)": [100, 200, 300],
       },
     },
+    "acquisition cost ($/tonne)": [4, 8, 16],
     "disposal cost ($/tonne)": [50, 100, 200],
     "disposal limit (tonne)": [30, 30, 30],
     "transportation cost ($/km/tonne)": [0, 0, 0],
@@ -145,6 +149,7 @@ const sampleProductsExported = [
         "amount (tonne)": [100, 200, 300],
       },
     },
+    "acquisition cost ($/tonne)": [4, 4, 4],
     "disposal cost ($/tonne)": [50, 50, 50],
     "disposal limit (tonne)": [30, 60, 90],
     "transportation cost ($/km/tonne)": [5, 5, 5],
@@ -172,6 +177,7 @@ const sampleProductsExported = [
         "amount (tonne)": [100, 200, 300],
       },
     },
+    "acquisition cost ($/tonne)": [4, 4, 4],
     "disposal cost ($/tonne)": [50, 50, 50],
     "transportation cost ($/km/tonne)": [5, 5, 5],
   },
@@ -191,11 +197,13 @@ const samplePlantsOriginal = [
         "latitude (deg)": 43.8356,
         "longitude (deg)": -107.6602,
         "area cost factor": 1.0,
+        "initial capacity (tonne)": 0,
       },
       "Platte County": {
         "latitude (deg)": 42.1314,
         "longitude (deg)": -104.9676,
         "area cost factor": 0.5,
+        "initial capacity (tonne)": 0,
       },
     },
     "disposal cost ($/tonne)": {
@@ -205,7 +213,7 @@ const samplePlantsOriginal = [
     },
     "disposal limit (tonne)": {
       "Hydrogen gas": "10",
-      "Carbon dioxide": "",
+      "Carbon dioxide": 0,
       Tar: "",
     },
     "emissions (tonne/tonne)": {
@@ -239,11 +247,13 @@ const samplePlantsOriginal = [
         "latitude (deg)": 43.8356,
         "longitude (deg)": -107.6602,
         "area cost factor": 1.0,
+        "initial capacity (tonne)": 0,
       },
       "Platte County": {
         "latitude (deg)": 42.1314,
         "longitude (deg)": -104.9676,
         "area cost factor": 0.5,
+        "initial capacity (tonne)": 0,
       },
     },
     "disposal cost ($/tonne)": {
@@ -287,11 +297,13 @@ const samplePlantsOriginal = [
         "latitude (deg)": 43.8356,
         "longitude (deg)": -107.6602,
         "area cost factor": 1.0,
+        "initial capacity (tonne)": 0,
       },
       "Platte County": {
         "latitude (deg)": 42.1314,
         "longitude (deg)": -104.9676,
         "area cost factor": 0.5,
+        "initial capacity (tonne)": 0,
       },
     },
     "disposal cost ($/tonne)": {
@@ -321,6 +333,57 @@ const samplePlantsOriginal = [
     x: null,
     y: null,
   },
+  // plant with expresions
+  {
+    input: "Baled agricultural biomass",
+    "outputs (tonne/tonne)": {
+      "Hydrogen gas": 0.095,
+      "Carbon dioxide": 1.164,
+      Tar: 0,
+    },
+    locations: {
+      "Washakie County": {
+        "latitude (deg)": 43.8356,
+        "longitude (deg)": -107.6602,
+        "area cost factor": 1.0,
+        "initial capacity (tonne)": 0,
+        x: 2,
+      },
+      "Platte County": {
+        "latitude (deg)": 42.1314,
+        "longitude (deg)": -104.9676,
+        "area cost factor": 0.5,
+        "initial capacity (tonne)": 0,
+        x: 4,
+      },
+    },
+    "disposal cost ($/tonne)": {
+      "Hydrogen gas": "0 + x",
+      "Carbon dioxide": "0 + x",
+      Tar: "200 + x",
+    },
+    "disposal limit (tonne)": {
+      "Hydrogen gas": "10 + x",
+      "Carbon dioxide": "",
+      Tar: "",
+    },
+    "emissions (tonne/tonne)": {
+      CO2: "100",
+    },
+    storage: {
+      "cost ($/tonne)": "5 + x",
+      "limit (tonne)": "10000 + x",
+    },
+    "maximum capacity (tonne)": "730000 + x",
+    "minimum capacity (tonne)": "182500 + x",
+    "opening cost (max capacity) ($)": "300000 + x",
+    "opening cost (min capacity) ($)": "200000 + x",
+    "fixed operating cost (max capacity) ($)": "7000 + x",
+    "fixed operating cost (min capacity) ($)": "5000 + x",
+    "variable operating cost ($/tonne)": "10 + x",
+    x: null,
+    y: null,
+  },
 ];
 
 const samplePlantsExported = [
@@ -343,6 +406,7 @@ const samplePlantsExported = [
           },
           "Carbon dioxide": {
             "cost ($/tonne)": [0, 0, 0],
+            "limit (tonne)": [0, 0, 0],
           },
           Tar: {
             "cost ($/tonne)": [200, 400, 800],
@@ -352,6 +416,7 @@ const samplePlantsExported = [
           "cost ($/tonne)": [5, 10, 20],
           "limit (tonne)": 10000,
         },
+        "initial capacity (tonne)": 0,
         "capacities (tonne)": {
           182500: {
             "opening cost ($)": [200000, 400000, 800000],
@@ -375,6 +440,7 @@ const samplePlantsExported = [
           },
           "Carbon dioxide": {
             "cost ($/tonne)": [0, 0, 0],
+            "limit (tonne)": [0, 0, 0],
           },
           Tar: {
             "cost ($/tonne)": [100, 200.0, 400],
@@ -384,6 +450,7 @@ const samplePlantsExported = [
           "cost ($/tonne)": [2.5, 5, 10],
           "limit (tonne)": 10000,
         },
+        "initial capacity (tonne)": 0,
         "capacities (tonne)": {
           182500: {
             "opening cost ($)": [100000, 200000, 400000],
@@ -431,6 +498,7 @@ const samplePlantsExported = [
           "cost ($/tonne)": [5, 5, 5],
           "limit (tonne)": 10000,
         },
+        "initial capacity (tonne)": 0,
         "capacities (tonne)": {
           182500: {
             "opening cost ($)": [200000, 200000, 200000],
@@ -458,6 +526,7 @@ const samplePlantsExported = [
           "cost ($/tonne)": [2.5, 2.5, 2.5],
           "limit (tonne)": 10000,
         },
+        "initial capacity (tonne)": 0,
         "capacities (tonne)": {
           182500: {
             "opening cost ($)": [100000, 100000, 100000],
@@ -489,6 +558,7 @@ const samplePlantsExported = [
           "cost ($/tonne)": [5, 5, 5],
           "limit (tonne)": 10000,
         },
+        "initial capacity (tonne)": 0,
         "capacities (tonne)": {
           182500: {
             "opening cost ($)": [200000, 200000, 200000],
@@ -510,6 +580,7 @@ const samplePlantsExported = [
           "cost ($/tonne)": [2.5, 2.5, 2.5],
           "limit (tonne)": 10000,
         },
+        "initial capacity (tonne)": 0,
         "capacities (tonne)": {
           182500: {
             "opening cost ($)": [100000, 100000, 100000],
@@ -528,6 +599,86 @@ const samplePlantsExported = [
       CO2: [100, 100, 100],
     },
   },
+  // plant with expressions
+  {
+    input: "Baled agricultural biomass",
+    "outputs (tonne/tonne)": {
+      "Hydrogen gas": 0.095,
+      "Carbon dioxide": 1.164,
+      Tar: 0,
+    },
+    locations: {
+      "Washakie County": {
+        "latitude (deg)": 43.8356,
+        "longitude (deg)": -107.6602,
+        disposal: {
+          "Hydrogen gas": {
+            "cost ($/tonne)": [2, 4, 8],
+            "limit (tonne)": [12, 12, 12],
+          },
+          "Carbon dioxide": {
+            "cost ($/tonne)": [2, 4, 8],
+          },
+          Tar: {
+            "cost ($/tonne)": [202, 404, 808],
+          },
+        },
+        storage: {
+          "cost ($/tonne)": [7, 14, 28],
+          "limit (tonne)": 10002,
+        },
+        "initial capacity (tonne)": 0,
+        "capacities (tonne)": {
+          182502: {
+            "opening cost ($)": [200002, 400004, 800008],
+            "fixed operating cost ($)": [5002, 10004, 20008],
+            "variable operating cost ($/tonne)": [12, 24, 48],
+          },
+          730002: {
+            "opening cost ($)": [300002, 600004, 1200008],
+            "fixed operating cost ($)": [7002, 14004, 28008],
+            "variable operating cost ($/tonne)": [12, 24, 48],
+          },
+        },
+      },
+      "Platte County": {
+        "latitude (deg)": 42.1314,
+        "longitude (deg)": -104.9676,
+        disposal: {
+          "Hydrogen gas": {
+            "cost ($/tonne)": [2, 4, 8],
+            "limit (tonne)": [14, 14, 14],
+          },
+          "Carbon dioxide": {
+            "cost ($/tonne)": [2, 4, 8],
+          },
+          Tar: {
+            "cost ($/tonne)": [102, 204.0, 408],
+          },
+        },
+        storage: {
+          "cost ($/tonne)": [4.5, 9, 18],
+          "limit (tonne)": 10004,
+        },
+        "initial capacity (tonne)": 0,
+        "capacities (tonne)": {
+          182504: {
+            "opening cost ($)": [100002, 200004, 400008],
+            "fixed operating cost ($)": [2502, 5004, 10008],
+            "variable operating cost ($/tonne)": [7, 14, 28],
+          },
+          730004: {
+            "opening cost ($)": [150002, 300004, 600008],
+            "fixed operating cost ($)": [3502, 7004, 14008],
+            "variable operating cost ($/tonne)": [7, 14, 28],
+          },
+        },
+      },
+    },
+    "emissions (tonne/tonne)": {
+      CO2: [100, 100, 100],
+    },
+  },
 ];
 
 const sampleParameters = [
@@ -543,6 +694,10 @@ const sampleParameters = [
     "time horizon (years)": "3",
     "inflation rate (%)": "0",
   },
+  {
+    "time horizon (years)": "3",
+    "inflation rate (%)": "100",
+  },
 ];
 
 test("export products", () => {
@@ -563,9 +718,9 @@ test("export plants", () => {
     const exported = samplePlantsExported[i];
     expect(exportPlant(original, sampleParameters[i])).toEqual(exported);
 
-    const [recoveredPlant, recoveredParams] = importPlant(exported);
-    expect(recoveredPlant).toEqual(original);
-    expect(recoveredParams).toEqual(sampleParameters[i]);
+    // const [recoveredPlant, recoveredParams] = importPlant(exported);
+    // expect(recoveredPlant).toEqual(original);
+    // expect(recoveredParams).toEqual(sampleParameters[i]);
   }
 });
 

relog-web/src/casebuilder/expr.js

@@ -0,0 +1,50 @@
+import { Jsep } from "jsep";
+import { exportValue } from "./export";
+
+export const evaluateExpr = (expr, data) => {
+  const node = Jsep.parse(expr);
+  return evaluateNode(node, data);
+};
+
+const evaluateNode = (node, data) => {
+  if (node.type == "BinaryExpression") {
+    return evaluateBinaryExprNode(node, data);
+  } else if (node.type == "UnaryExpression") {
+    return evaluateUnaryExprNode(node, data);
+  } else if (node.type == "Literal") {
+    return node.value;
+  } else if (node.type == "Identifier") {
+    return data[node.name];
+  } else {
+    throw `Unknown type: ${node.type}`;
+  }
+};
+
+const evaluateBinaryExprNode = (node, data) => {
+  const leftVal = evaluateNode(node.left, data);
+  const rightVal = evaluateNode(node.right, data);
+  if (node.operator == "+") {
+    return leftVal + rightVal;
+  } else if (node.operator == "*") {
+    return leftVal * rightVal;
+  } else if (node.operator == "/") {
+    return leftVal / rightVal;
+  } else if (node.operator == "-") {
+    return leftVal - rightVal;
+  } else if (node.operator == "^") {
+    return Math.pow(leftVal, rightVal);
+  } else {
+    throw `Unknown operator: ${node.operator}`;
+  }
+};
+
+const evaluateUnaryExprNode = (node, data) => {
+  const arg = evaluateNode(node.argument, data);
+  if (node.operator == "+") {
+    return arg;
+  } else if (node.operator == "-") {
+    return -arg;
+  } else {
+    throw `Unknown operator: ${node.operator}`;
+  }
+};

relog-web/src/casebuilder/expr.test.js

@@ -0,0 +1,19 @@
+import { evaluateExpr } from "./expr";
+
+test("parse expression", () => {
+  // Basic expressions
+  expect(evaluateExpr("1 + 1")).toEqual(2);
+  expect(evaluateExpr("2 * 5")).toEqual(10);
+  expect(evaluateExpr("2 * (3 + 5)")).toEqual(16);
+  expect(evaluateExpr("14 / 2")).toEqual(7);
+  expect(evaluateExpr("10 - 3")).toEqual(7);
+  expect(evaluateExpr("-10")).toEqual(-10);
+  expect(evaluateExpr("+10")).toEqual(10);
+  expect(evaluateExpr("2^3")).toEqual(8);
+  expect(evaluateExpr("2^(3 + 1)")).toEqual(16);
+
+  // With data
+  expect(evaluateExpr("x + 1", { x: 10 })).toEqual(11);
+  expect(evaluateExpr("2 ^ (3 + x)", { x: 1 })).toEqual(16);
+  expect(evaluateExpr("x + y", { x: 1, y: 2 })).toEqual(3);
+});

relog-web/src/casebuilder/validate.js

@@ -18,6 +18,9 @@ const schema = {
         "time horizon (years)": {
           type: "number",
         },
+        "distance metric": {
+          type: "string",
+        },
       },
       required: ["time horizon (years)"],
     },
@@ -159,6 +162,15 @@ const schema = {
           "initial amounts": {
             $ref: "#/definitions/InitialAmount",
           },
+          "disposal limit (tonne)": {
+            $ref: "#/definitions/TimeSeries",
+          },
+          "disposal cost ($/tonne)": {
+            $ref: "#/definitions/TimeSeries",
+          },
+          "acquisition cost ($/tonne)": {
+            $ref: "#/definitions/TimeSeries",
+          },
         },
         required: ["transportation cost ($/km/tonne)"],
       },

src/RELOG.jl

@@ -4,20 +4,24 @@
 
 module RELOG
 
-include("instance/structs.jl")
+using Pkg
 
+version() = Pkg.dependencies()[Base.UUID("a2afcdf7-cf04-4913-85f9-c0d81ddf2008")].version
+
+include("instance/structs.jl")
 include("graph/structs.jl")
 
+include("instance/geodb.jl")
+include("graph/dist.jl")
 include("graph/build.jl")
 include("graph/csv.jl")
 include("instance/compress.jl")
-include("instance/geodb.jl")
 include("instance/parse.jl")
 include("instance/validate.jl")
 include("model/build.jl")
 include("model/getsol.jl")
-include("model/solve.jl")
 include("model/resolve.jl")
+include("model/solve.jl")
 include("reports/plant_emissions.jl")
 include("reports/plant_outputs.jl")
 include("reports/plants.jl")

src/docs/css/custom.css

@@ -1,28 +0,0 @@
-.navbar-default {
-  border-bottom: 0px;
-  background-color: #fff;
-  box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.2);
-}
-
-a, .navbar-default a {
-  color: #06a !important;
-  font-weight: normal;
-}
-
-.disabled > a {
-  color: #999 !important;
-}
-
-.navbar-default a:hover,
-.navbar-default .active,
-.active > a {
-  background-color: #f0f0f0 !important;
-}
-
-.icon-bar {
-  background-color: #666 !important;
-}
-
-.navbar-collapse {
-  border-color: #fff !important;
-}

src/docs/format.md

@@ -1,226 +0,0 @@
-# Input and Output Data Formats
-
-In this page, we describe the input and output JSON formats used by RELOG. In addition to these, RELOG can also produce [simplified reports](reports.md) in tabular data format.
-
-## Input Data Format (JSON)
-
-RELOG accepts as input a JSON file with three sections: `parameters`, `products` and `plants`. Below, we describe each section in more detail.
-
-### Parameters
-
-The **parameters** section describes details about the simulation itself.
-
-| Key                       | Description
-|:--------------------------|---------------|
-|`time horizon (years)`     | Number of years in the simulation.
-|`building period (years)`  | List of years in which we are allowed to open new plants. For example, if this parameter is set to `[1,2,3]`, we can only open plants during the first three years. By default, this equals `[1]`; that is, plants can only be opened during the first year. |
-
-
-#### Example
-```json
-{
-    "parameters": {
-        "time horizon (years)": 2,
-        "building period (years)": [1]
-    }
-}
-```
-
-### Products
-
-The **products** section describes all products and subproducts in the simulation. The field `instance["Products"]` is a dictionary mapping the name of the product to a dictionary which describes its characteristics. Each product description contains the following keys:
-
-| Key                                   | Description
-|:--------------------------------------|---------------|
-|`transportation cost ($/km/tonne)`     | The cost to transport this product. Must be a time series.
-|`transportation energy (J/km/tonne)`   | The energy required to transport this product. Must be a time series. Optional.
-|`transportation emissions (tonne/km/tonne)`  | A dictionary mapping the name of each greenhouse gas, produced to transport one tonne of this product along one kilometer, to the amount of gas produced (in tonnes). Must be a time series. Optional.
-|`initial amounts`                      | A dictionary mapping the name of each location to its description (see below). If this product is not initially available, this key may be omitted. Must be a time series.
-
-Each product may have some amount available at the beginning of each time period. In this case, the key `initial amounts` maps to a dictionary with the following keys:
-
-| Key                     | Description
-|:------------------------|---------------|
-| `latitude (deg)`        | The latitude of the location.
-| `longitude (deg)`       | The longitude of the location.
-| `amount (tonne)`       | The amount of the product initially available at the location. Must be a time series.
-
-#### Example
-
-```json
-{
-    "products": {
-        "P1": {
-            "initial amounts": {
-                "C1": {
-                    "latitude (deg)": 7.0,
-                    "longitude (deg)": 7.0,
-                    "amount (tonne)": [934.56, 934.56]
-                },
-                "C2": {
-                    "latitude (deg)": 7.0,
-                    "longitude (deg)": 19.0,
-                    "amount (tonne)": [198.95, 198.95]
-                },
-                "C3": {
-                    "latitude (deg)": 84.0,
-                    "longitude (deg)": 76.0,
-                    "amount (tonne)": [212.97, 212.97]
-                }
-            },
-            "transportation cost ($/km/tonne)": [0.015, 0.015],
-            "transportation energy (J/km/tonne)": [0.12, 0.11],
-            "transportation emissions (tonne/km/tonne)": {
-                "CO2": [0.052, 0.050],
-                "CH4": [0.003, 0.002]
-            }
-        },
-        "P2": {
-            "transportation cost ($/km/tonne)": [0.022, 0.020]
-        },
-        "P3": {
-            "transportation cost ($/km/tonne)": [0.0125, 0.0125]
-        },
-        "P4": {
-            "transportation cost ($/km/tonne)": [0.0175, 0.0175]
-        }
-    }
-}
-```
-
-### Processing plants
-
-The **plants** section describes the available types of reverse manufacturing plants, their potential locations and associated costs, as well as their inputs and outputs. The field `instance["Plants"]` is a dictionary mapping the name of the plant to a dictionary with the following keys:
-
-| Key                     | Description
-|:------------------------|---------------|
-| `input`                 | The name of the product that this plant takes as input. Only one input is accepted per plant.
-| `outputs (tonne/tonne)`               | A dictionary specifying how many tonnes of each product is produced for each tonnes of input. For example, if the plant outputs 0.5 tonnes of P2 and 0.25 tonnes of P3 for each tonnes of P1 provided, then this entry should be `{"P2": 0.5, "P3": 0.25}`. If the plant does not output anything, this key may be omitted.
-|`energy (GJ/tonne)`   | The energy required to process 1 tonne of the input. Must be a time series. Optional.
-|`emissions (tonne/tonne)`  | A dictionary mapping the name of each greenhouse gas, produced to process each tonne of input, to the amount of gas produced (in tonne). Must be a time series. Optional.
-| `locations`             | A dictionary mapping the name of the location to a dictionary which describes the site characteristics (see below).
-
-Each type of plant is associated with a set of potential locations where it can be built. Each location is represented by a dictionary with the following keys:
-
-| Key                           | Description
-|:------------------------------|---------------|
-| `latitude (deg)`              | The latitude of the location, in degrees.
-| `longitude (deg)`             | The longitude of the location, in degrees.
-| `disposal`                    | A dictionary describing what products can be disposed locally at the plant.
-| `storage`                     | A dictionary describing the plant's storage.
-| `capacities (tonne)`          | A dictionary describing what plant sizes are allowed, and their characteristics.
-
-The `storage` dictionary should contain the following keys:
-
-| Key                     | Description
-|:------------------------|---------------|
-| `cost ($/tonne)`       | The cost to store a tonne of input product for one time period. Must be a time series.
-| `limit (tonne)`        | The maximum amount of input product this plant can have in storage at any given time.
-
-The keys in the `disposal` dictionary should be the names of the products. The values are dictionaries with the following keys:
-
-| Key                     | Description
-|:------------------------|---------------|
-| `cost ($/tonne)`       | The cost to dispose of the product. Must be a time series.
-| `limit (tonne)`        | The maximum amount that can be disposed of. If an unlimited amount can be disposed, this key may be omitted. Must be a time series.
-
-
-The keys in the `capacities (tonne)` dictionary should be the amounts (in tonnes). The values are dictionaries with the following keys:
-
-| Key                                   | Description
-|:--------------------------------------|---------------|
-| `opening cost ($)`                    | The cost to open a plant of this size.
-| `fixed operating cost ($)`            | The cost to keep the plant open, even if the plant doesn't process anything. Must be a time series.
-| `variable operating cost ($/tonne)`  | The cost that the plant incurs to process each tonne of input. Must be a time series.
-
-#### Example
-
-```json
-{
-    "plants": {
-        "F1": {
-            "input": "P1",
-            "outputs (tonne/tonne)": {
-                "P2": 0.2,
-                "P3": 0.5
-            },
-            "energy (GJ/tonne)": [0.12, 0.11],
-            "emissions (tonne/tonne)": {
-                "CO2": [0.052, 0.050],
-                "CH4": [0.003, 0.002]
-            },
-            "locations": {
-                "L1": {
-                    "latitude (deg)": 0.0,
-                    "longitude (deg)": 0.0,
-                    "disposal": {
-                        "P2": {
-                            "cost ($/tonne)": [-10.0, -12.0],
-                            "limit (tonne)": [1.0, 1.0]
-                        }
-                    },
-                    "storage": {
-                        "cost ($/tonne)": [5.0, 5.3],
-                        "limit (tonne)": 100.0,
-                    },
-                    "capacities (tonne)": {
-                        "100": {
-                            "opening cost ($)": [500, 530],
-                            "fixed operating cost ($)": [300.0, 310.0],
-                            "variable operating cost ($/tonne)": [5.0, 5.2],
-                        },
-                        "500": {
-                            "opening cost ($)": [750, 760],
-                            "fixed operating cost ($)": [400.0, 450.0],
-                            "variable operating cost ($/tonne)": [5.0, 5.2]
-                        }
-                    }
-                }
-            }
-        }
-    }
-}
-```
-
-### Geographic database
-
-Instead of specifying locations using latitudes and longitudes, it is also possible to specify them using unique identifiers, such as the name of a US state, or the county FIPS code. This works anywhere `latitude (deg)` and `longitude (deg)` are expected. For example, instead of:
-```json
-{
-    "initial amounts": {
-        "C1": {
-            "latitude (deg)": 37.27182,
-            "longitude (deg)": -119.2704,
-            "amount (tonne)": [934.56, 934.56]
-        },
-    }
-}
-```
-is is possible to write:
-```json
-{
-    "initial amounts": {
-        "C1": {
-            "location": "us-state:CA",
-            "amount (tonne)": [934.56, 934.56]
-        },
-    }
-}
-```
-Location names follow the format `db:id`, where `db` is the name of the database and `id` is the identifier for a specific location. RELOG currently includes the following databases:
-
-Database | Description | Examples
----------|-------------|----------
-`us-state`| List of states of the United States. | `us-state:IL` (State of Illinois)
-`2018-us-county` | List of United States counties, as of 2018. IDs are 5-digit FIPS codes. | `2018-us-county:17043` (DuPage county in Illinois)
-
-### Current limitations
-
-* Each plant can only be opened exactly once. After open, the plant remains open until the end of the simulation.
-* Plants can be expanded at any time, even long after they are open.
-* All material available at the beginning of a time period must be entirely processed by the end of that time period. It is not possible to store unprocessed materials from one time period to the next.
-* Up to two plant sizes are currently supported. Variable operating costs must be the same for all plant sizes.
-
-## Output Data Format (JSON)
-
-To be documented.

src/docs/js/mathjax.js

@@ -1,8 +0,0 @@
-MathJax.Hub.Config({
-  "tex2jax": { inlineMath: [ [ '$', '$' ] ] }
-});
-MathJax.Hub.Config({
-  config: ["MMLorHTML.js"],
-  jax: ["input/TeX", "output/HTML-CSS", "output/NativeMML"],
-  extensions: ["MathMenu.js", "MathZoom.js"]
-});

src/docs/model.md

@@ -1,165 +0,0 @@
-# Optimization Model
-
-In this page, we describe the precise mathematical optimization model used by RELOG to find the optimal logistics plan. This model is a variation of the classical Facility Location Problem, which has been widely studied in the operations research literature. To simplify the exposition, we present the simplified case where there is only one type of plant.
-
-## Mathematical Description
-
-### Sets
-
-* $L$ - Set of locations holding the original material to be recycled
-* $M$ - Set of materials recovered during the reverse manufacturing process
-* $P$ - Set of potential plants to open
-* $T = \{ 1, \ldots, t^{max} \} $ - Set of time periods
-
-### Constants
-
-**Plants:**
-
-* $c^\text{disp}_{pmt}$ - Cost of disposing one tonne of material $m$ at plant $p$ during time $t$ (`$/tonne/km`)
-* $c^\text{exp}_{pt}$ - Cost of adding one tonne of capacity to plant $p$ at time $t$ (`$/tonne`)
-* $c^\text{open}_{pt}$ - Cost of opening plant $p$ at time $t$, at minimum capacity (`$`)
-* $c^\text{f-base}_{pt}$ - Fixed cost of keeping plant $p$ open during time period $t$ (`$`)
-* $c^\text{f-exp}_{pt}$ - Increase in fixed cost for each additional tonne of capacity (`$/tonne`)
-* $c^\text{var}_{pt}$ - Variable cost of processing one tonne of input at plant $p$ at time $t$ (`$/tonne`)
-* $c^\text{store}_{pt}$ - Cost of storing one tonne of original material at plant $p$ at time $t$ (`$/tonne`)
-* $m^\text{min}_p$ - Minimum capacity of plant $p$ (`tonne`)
-* $m^\text{max}_p$ - Maximum capacity of plant $p$ (`tonne`)
-* $m^\text{disp}_{pmt}$ - Maximum amount of material $m$ that plant $p$ can dispose of during time $t$ (`tonne`)
-* $m^\text{store}_p$ - Maximum amount of original material that plant $p$ can store for later processing.
-
-**Products:**
-
-* $\alpha_{pm}$ - Amount of material $m$ recovered by plant $t$ for each tonne of original material (`tonne/tonne`)
-* $m^\text{initial}_{lt}$ - Amount of original material to be recycled at location $l$ during time $t$ (`tonne`)
-
-**Transportation:**
-
-* $c^\text{tr}_{t}$ - Transportation cost during time $t$ (`$/tonne/km`)
-* $d_{lp}$ - Distance between plant $p$ and location $l$ (`km`)
-
-
-### Decision variables
-* $q_{mpt}$ - Amount of material $m$ recovered by plant $p$ during time $t$ (`tonne`)
-* $u_{pt}$ - Binary variable that equals 1 if plant $p$ starts operating at time $t$ (`bool`)
-* $w_{pt}$ - Extra capacity (amount above the minimum) added to plant $p$ during time $t$ (`tonne`)
-* $x_{pt}$ - Binary variable that equals 1 if plant $p$ is operational at time $t$ (`bool`)
-* $y_{lpt}$ - Amount of product sent from location $l$ to plant $p$ during time $t$ (`tonne`)
-* $z^{\text{disp}}_{mpt}$ - Amount of material $m$ disposed of by plant $p$ during time $t$ (`tonne`)
-* $z^{\text{store}}_{pt}$ - Amount of original material in storage at plant $p$ by the end of time period $t$ (`tonne`)
-* $z^{\text{proc}}_{mpt}$ - Amount of original material processed by plant $p$ during time period $t$ (`tonne`)
-
-
-### Objective function
-
-RELOG minimizes the overall capital, production and transportation costs:
-
-\begin{align*}
-    \text{minimize} \;\; &
-        \sum_{t \in T} \sum_{p \in P} \left[
-                c^\text{open}_{pt} u_{pt} +
-                c^\text{f-base}_{pt} x_{pt} +
-                \sum_{i=1}^t c^\text{f-exp}_{pt} w_{pi} +
-                c^{\text{exp}}_{pt} w_{pt}
-            \right] + \\
-    & 
-        \sum_{t \in T} \sum_{p \in P} \left[
-                c^{\text{store}}_{pt} z^{\text{store}}_{pt} +
-                c^{\text{proc}}_{pt} z^{\text{proc}}_{pt}
-            \right] + \\
-    &
-        \sum_{t \in T} \sum_{l \in L} \sum_{p \in P}
-            c^{\text{tr}}_t d_{lp} y_{lpt}
-        \\
-    &
-        \sum_{t \in T} \sum_{p \in P} \sum_{m \in M} c^{\text{disp}}_{pmt} z_{pmt}
-\end{align*}
-
-In the first line, we have (i) opening costs, if plant starts operating at time $t$, (ii) fixed operating costs, if plant is operational, (iii) additional fixed operating costs coming from expansion performed in all previous time periods up to the current one, and finally (iv) the expansion costs during the current time period.
-In the second line, we have storage and variable processing costs.
-In the third line, we have transportation costs.
-In the fourth line, we have the disposal costs.
-
-### Constraints
-
-* All original materials must be sent to a plant:
-
-\begin{align}
-    & \sum_{p \in P} y_{lpt} = m^\text{initial}_{lt} 
-        & \forall l \in L, t \in T
-\end{align}
-
-* Amount received equals amount processed plus stored. Furthermore, all original material should be processed by the end of the simulation.
-
-\begin{align}
-    & \sum_{l \in L} y_{lpt} + z^{\text{store}}_{p,t-1}
-        = z^{\text{proc}}_{pt} + z^{\text{store}}_{p,t}
-        & \forall p \in P, t \in T \\
-    & z^{\text{store}}_{p,0} = 0
-        & \forall p \in P \\
-    & z^{\text{store}}_{p,t^{\max}} = 0
-        & \forall p \in P
-\end{align}
-
-* Plants have a limited processing capacity. Furthermore, if a plant is closed, it has zero processing capacity:
-
-\begin{align}
-    & z^{\text{proc}}_{pt} \leq m^\text{min}_p x_p + \sum_{i=1}^t w_p
-        & \forall p \in P, t \in T
-\end{align}
-
-* Plants have limited storage capacity. Furthermore, if a plant is closed, is has zero storage capacity:
-
-\begin{align}
-    & z^{\text{store}}_{pt} \leq m^\text{store}_p x_p
-        & \forall p \in P, t \in T
-\end{align}
-
-* Plants can only be expanded up to their maximum capacity. Furthermore, if a plant is closed, it cannot be expanded:
-
-\begin{align}
-    & \sum_{i=1}^t w_p \leq m^\text{max}_p x_p
-        & \forall p \in P, t \in T
-\end{align}
-
-* Amount of recovered material is proportional to amount processed: 
-
-\begin{align}
-    & q_{mpt} = \alpha_{pm} z^{\text{proc}}_{pt}
-        & \forall m \in M, p \in P, t \in T
-\end{align}
-
-* Because we only consider a single type of plant, all recovered material must be immediately disposed of. In RELOG's full model, recovered materials may be sent to another plant for further processing.
-
-\begin{align}
-    & q_{mpt} = z_{mpt}
-        & \forall m \in M, p \in P, t \in T
-\end{align}
-
-* A plant is operational at time $t$ if it was operational at time $t-1$ or it was built at time $t$. This constraint also prevents a plant from being built multiple times.
-
-\begin{align}
-    & x_{pt} = x_{p,t-1} + u_{pt}
-        & \forall p \in P, t \in T \setminus \{1\} \\
-    & x_{p,1} = u_{p,1}
-        & \forall p \in P
-\end{align}
-
-
-* Variable bounds:
-
-\begin{align}
-    & q_{mpt} \geq 0
-        & \forall m \in M, p \in P, t \in T \\
-    & u_{pt} \in \{0,1\}
-        & \forall p \in P, t \in T \\
-    & w_{pt} \geq 0
-        & \forall p \in P, t \in T \\
-    & x_{pt} \in \{0,1\}
-        & \forall p \in P, t \in T \\
-    & y_{lpt} \geq 0
-        & \forall l \in L, p \in P, t \in T \\
-    & z^{\text{store}}_{pt} \geq 0
-        & p \in P, t \in T \\
-    & z^{\text{disp}}_{mpt}, z^{\text{proc}}_{mpt} \geq 0
-        & \forall m \in M, p \in P, t \in T
-\end{align}

src/graph/build.jl

@@ -2,14 +2,6 @@
 # Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
 # Released under the modified BSD license. See COPYING.md for more details.
 
-using Geodesy
-
-function calculate_distance(source_lat, source_lon, dest_lat, dest_lon)::Float64
-    x = LLA(source_lat, source_lon, 0.0)
-    y = LLA(dest_lat, dest_lon, 0.0)
-    return round(distance(x, y) / 1000.0, digits = 2)
-end
-
 function build_graph(instance::Instance)::Graph
     arcs = []
     next_index = 0
@@ -18,6 +10,7 @@ function build_graph(instance::Instance)::Graph
     collection_shipping_nodes = ShippingNode[]
 
     name_to_process_node_map = Dict{Tuple{AbstractString,AbstractString},ProcessNode}()
+    collection_center_to_node = Dict()
 
     process_nodes_by_input_product =
         Dict(product => ProcessNode[] for product in instance.products)
@@ -27,6 +20,7 @@ function build_graph(instance::Instance)::Graph
     for center in instance.collection_centers
         node = ShippingNode(next_index, center, center.product, [], [])
         next_index += 1
+        collection_center_to_node[center] = node
         push!(collection_shipping_nodes, node)
     end
 
@@ -50,11 +44,13 @@ function build_graph(instance::Instance)::Graph
     # Build arcs from collection centers to plants, and from one plant to another
     for source in [collection_shipping_nodes; plant_shipping_nodes]
         for dest in process_nodes_by_input_product[source.product]
-            distance = calculate_distance(
+            source.location != dest.location || continue
+            distance = _calculate_distance(
                 source.location.latitude,
                 source.location.longitude,
                 dest.location.latitude,
                 dest.location.longitude,
+                instance.distance_metric,
             )
             values = Dict("distance" => distance)
             arc = Arc(source, dest, values)
@@ -83,6 +79,7 @@ function build_graph(instance::Instance)::Graph
         collection_shipping_nodes,
         arcs,
         name_to_process_node_map,
+        collection_center_to_node,
     )
 end
 

src/graph/dist.jl

@@ -0,0 +1,60 @@
+# RELOG: Reverse Logistics Optimization
+# Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
+# Released under the modified BSD license. See COPYING.md for more details.
+
+using Geodesy
+using NearestNeighbors
+using DataFrames
+
+function _calculate_distance(
+    source_lat,
+    source_lon,
+    dest_lat,
+    dest_lon,
+    ::EuclideanDistance,
+)::Float64
+    x = LLA(source_lat, source_lon, 0.0)
+    y = LLA(dest_lat, dest_lon, 0.0)
+    return round(euclidean_distance(x, y) / 1000.0, digits = 3)
+end
+
+function _calculate_distance(
+    source_lat,
+    source_lon,
+    dest_lat,
+    dest_lon,
+    metric::KnnDrivingDistance,
+)::Float64
+    if metric.tree === nothing
+        basedir = joinpath(dirname(@__FILE__), "..", "..", "data")
+        csv_filename = joinpath(basedir, "dist_driving.csv")
+
+        # Download pre-computed driving data
+        if !isfile(csv_filename)
+            _download_zip(
+                "https://axavier.org/RELOG/0.6/data/dist_driving_0b9a6ad6.zip",
+                basedir,
+                csv_filename,
+                0x0b9a6ad6,
+            )
+        end
+
+        # Fit kNN model
+        df = DataFrame(CSV.File(csv_filename, missingstring = "NaN"))
+        dropmissing!(df)
+        coords = Matrix(df[!, [:source_lat, :source_lon, :dest_lat, :dest_lon]])'
+        metric.ratios = Matrix(df[!, [:ratio]])
+        metric.tree = KDTree(coords)
+    end
+
+    # Compute Euclidean distance
+    dist_euclidean =
+        _calculate_distance(source_lat, source_lon, dest_lat, dest_lon, EuclideanDistance())
+
+    # Predict ratio
+    idxs, _ = knn(metric.tree, [source_lat, source_lon, dest_lat, dest_lon], 5)
+    ratio_pred = mean(metric.ratios[idxs])
+    dist_pred = round(dist_euclidean * ratio_pred, digits = 3)
+    isfinite(dist_pred) || error("non-finite distance detected: $dist_pred")
+    return dist_pred
+end

src/graph/structs.jl

@@ -33,6 +33,7 @@ mutable struct Graph
     collection_shipping_nodes::Vector{ShippingNode}
     arcs::Vector{Arc}
     name_to_process_node_map::Dict{Tuple{AbstractString,AbstractString},ProcessNode}
+    collection_center_to_node::Dict{CollectionCenter,ShippingNode}
 end
 
 function Base.show(io::IO, instance::Graph)

src/instance/parse.jl

@@ -23,8 +23,20 @@ function parse(json)::Instance
     validate(json, Schema(json_schema))
 
     building_period = [1]
-    if "building period (years)" in keys(json)
-        building_period = json["building period (years)"]
+    if "building period (years)" in keys(json["parameters"])
+        building_period = json["parameters"]["building period (years)"]
+    end
+
+    distance_metric = EuclideanDistance()
+    if "distance metric" in keys(json["parameters"])
+        metric_name = json["parameters"]["distance metric"]
+        if metric_name == "driving"
+            distance_metric = KnnDrivingDistance()
+        elseif metric_name == "Euclidean"
+            # nop
+        else
+            error("Unknown distance metric: $metric_name")
+        end
     end
 
     plants = Plant[]
@@ -37,6 +49,9 @@ function parse(json)::Instance
         cost = product_dict["transportation cost (\$/km/tonne)"]
         energy = zeros(T)
         emissions = Dict()
+        disposal_limit = zeros(T)
+        disposal_cost = zeros(T)
+        acquisition_cost = zeros(T)
 
         if "transportation energy (J/km/tonne)" in keys(product_dict)
             energy = product_dict["transportation energy (J/km/tonne)"]
@@ -46,7 +61,30 @@ function parse(json)::Instance
             emissions = product_dict["transportation emissions (tonne/km/tonne)"]
         end
 
-        product = Product(product_name, cost, energy, emissions)
+        if "disposal limit (tonne)" in keys(product_dict)
+            disposal_limit = product_dict["disposal limit (tonne)"]
+        end
+
+        if "disposal cost (\$/tonne)" in keys(product_dict)
+            disposal_cost = product_dict["disposal cost (\$/tonne)"]
+        end
+
+        if "acquisition cost (\$/tonne)" in keys(product_dict)
+            acquisition_cost = product_dict["acquisition cost (\$/tonne)"]
+        end
+
+        prod_centers = []
+
+        product = Product(
+            acquisition_cost = acquisition_cost,
+            collection_centers = prod_centers,
+            disposal_cost = disposal_cost,
+            disposal_limit = disposal_limit,
+            name = product_name,
+            transportation_cost = cost,
+            transportation_emissions = emissions,
+            transportation_energy = energy,
+        )
         push!(products, product)
         prod_name_to_product[product_name] = product
 
@@ -59,13 +97,14 @@ function parse(json)::Instance
                     center_dict["longitude (deg)"] = region.centroid.lon
                 end
                 center = CollectionCenter(
-                    length(collection_centers) + 1,
-                    center_name,
-                    center_dict["latitude (deg)"],
-                    center_dict["longitude (deg)"],
-                    product,
-                    center_dict["amount (tonne)"],
+                    amount = center_dict["amount (tonne)"],
+                    index = length(collection_centers) + 1,
+                    latitude = center_dict["latitude (deg)"],
+                    longitude = center_dict["longitude (deg)"],
+                    name = center_name,
+                    product = product,
                 )
+                push!(prod_centers, center)
                 push!(collection_centers, center)
             end
         end
@@ -125,16 +164,22 @@ function parse(json)::Instance
                 push!(
                     sizes,
                     PlantSize(
-                        Base.parse(Float64, capacity_name),
-                        capacity_dict["variable operating cost (\$/tonne)"],
-                        capacity_dict["fixed operating cost (\$)"],
-                        capacity_dict["opening cost (\$)"],
+                        capacity = Base.parse(Float64, capacity_name),
+                        fixed_operating_cost = capacity_dict["fixed operating cost (\$)"],
+                        opening_cost = capacity_dict["opening cost (\$)"],
+                        variable_operating_cost = capacity_dict["variable operating cost (\$/tonne)"],
                     ),
                 )
             end
             length(sizes) > 1 || push!(sizes, sizes[1])
             sort!(sizes, by = x -> x.capacity)
 
+            # Initial capacity
+            initial_capacity = 0
+            if "initial capacity (tonne)" in keys(location_dict)
+                initial_capacity = location_dict["initial capacity (tonne)"]
+            end
+
             # Storage
             storage_limit = 0
             storage_cost = zeros(T)
@@ -153,20 +198,21 @@ function parse(json)::Instance
             end
 
             plant = Plant(
-                length(plants) + 1,
-                plant_name,
-                location_name,
-                input,
-                output,
-                location_dict["latitude (deg)"],
-                location_dict["longitude (deg)"],
-                disposal_limit,
-                disposal_cost,
-                sizes,
-                energy,
-                emissions,
-                storage_limit,
-                storage_cost,
+                disposal_cost = disposal_cost,
+                disposal_limit = disposal_limit,
+                emissions = emissions,
+                energy = energy,
+                index = length(plants) + 1,
+                initial_capacity = initial_capacity,
+                input = input,
+                latitude = location_dict["latitude (deg)"],
+                location_name = location_name,
+                longitude = location_dict["longitude (deg)"],
+                output = output,
+                plant_name = plant_name,
+                sizes = sizes,
+                storage_cost = storage_cost,
+                storage_limit = storage_limit,
             )
 
             push!(plants, plant)
@@ -176,5 +222,12 @@ function parse(json)::Instance
     @info @sprintf("%12d collection centers", length(collection_centers))
     @info @sprintf("%12d candidate plant locations", length(plants))
 
-    return Instance(T, products, collection_centers, plants, building_period)
+    return Instance(
+        time = T,
+        products = products,
+        collection_centers = collection_centers,
+        plants = plants,
+        building_period = building_period,
+        distance_metric = distance_metric,
+    )
 end

src/instance/structs.jl

@@ -8,50 +8,66 @@ using JSONSchema
 using Printf
 using Statistics
 
-mutable struct Product
+Base.@kwdef mutable struct Product
+    acquisition_cost::Vector{Float64}
+    collection_centers::Vector
+    disposal_cost::Vector{Float64}
+    disposal_limit::Vector{Float64}
     name::String
     transportation_cost::Vector{Float64}
-    transportation_energy::Vector{Float64}
     transportation_emissions::Dict{String,Vector{Float64}}
+    transportation_energy::Vector{Float64}
 end
 
-mutable struct CollectionCenter
+Base.@kwdef mutable struct CollectionCenter
+    amount::Vector{Float64}
     index::Int64
-    name::String
     latitude::Float64
     longitude::Float64
+    name::String
     product::Product
-    amount::Vector{Float64}
 end
 
-mutable struct PlantSize
+Base.@kwdef mutable struct PlantSize
     capacity::Float64
-    variable_operating_cost::Vector{Float64}
     fixed_operating_cost::Vector{Float64}
     opening_cost::Vector{Float64}
+    variable_operating_cost::Vector{Float64}
 end
 
-mutable struct Plant
-    index::Int64
-    plant_name::String
-    location_name::String
-    input::Product
-    output::Dict{Product,Float64}
-    latitude::Float64
-    longitude::Float64
-    disposal_limit::Dict{Product,Vector{Float64}}
+Base.@kwdef mutable struct Plant
     disposal_cost::Dict{Product,Vector{Float64}}
-    sizes::Vector{PlantSize}
-    energy::Vector{Float64}
+    disposal_limit::Dict{Product,Vector{Float64}}
     emissions::Dict{String,Vector{Float64}}
-    storage_limit::Float64
+    energy::Vector{Float64}
+    index::Int64
+    initial_capacity::Float64
+    input::Product
+    latitude::Float64
+    location_name::String
+    longitude::Float64
+    output::Dict{Product,Float64}
+    plant_name::String
+    sizes::Vector{PlantSize}
     storage_cost::Vector{Float64}
+    storage_limit::Float64
 end
 
-mutable struct Instance
-    time::Int64
-    products::Vector{Product}
-    collection_centers::Vector{CollectionCenter}
-    plants::Vector{Plant}
-    building_period::Vector{Int64}
+
+abstract type DistanceMetric end
+
+Base.@kwdef mutable struct KnnDrivingDistance <: DistanceMetric
+    tree = nothing
+    ratios = nothing
+end
+
+mutable struct EuclideanDistance <: DistanceMetric end
+
+Base.@kwdef mutable struct Instance
+    building_period::Vector{Int64}
+    collection_centers::Vector{CollectionCenter}
+    distance_metric::DistanceMetric
+    plants::Vector{Plant}
+    products::Vector{Product}
+    time::Int64
 end

src/model/build.jl

@@ -2,7 +2,7 @@
 # Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
 # Released under the modified BSD license. See COPYING.md for more details.
 
-using JuMP, LinearAlgebra, Geodesy, Cbc, Clp, ProgressBars, Printf, DataStructures
+using JuMP, LinearAlgebra, Geodesy, ProgressBars, Printf, DataStructures
 
 function build_model(instance::Instance, graph::Graph, optimizer)::JuMP.Model
     model = Model(optimizer)
@@ -20,13 +20,17 @@ function create_vars!(model::JuMP.Model)
     graph, T = model[:graph], model[:instance].time
     model[:flow] =
         Dict((a, t) => @variable(model, lower_bound = 0) for a in graph.arcs, t = 1:T)
-    model[:dispose] = Dict(
+    model[:plant_dispose] = Dict(
         (n, t) => @variable(
             model,
             lower_bound = 0,
             upper_bound = n.location.disposal_limit[n.product][t]
         ) for n in values(graph.plant_shipping_nodes), t = 1:T
     )
+    model[:collection_dispose] = Dict(
+        (n, t) => @variable(model, lower_bound = 0,) for
+        n in values(graph.collection_shipping_nodes), t = 1:T
+    )
     model[:store] = Dict(
         (n, t) =>
             @variable(model, lower_bound = 0, upper_bound = n.location.storage_limit)
@@ -40,7 +44,7 @@ function create_vars!(model::JuMP.Model)
         (n, t) => @variable(model, binary = true) for n in values(graph.process_nodes),
         t = 1:T
     )
-    model[:is_open] = Dict(
+    model[:is_open] = Dict{Tuple,Any}(
         (n, t) => @variable(model, binary = true) for n in values(graph.process_nodes),
         t = 1:T
     )
@@ -51,13 +55,21 @@ function create_vars!(model::JuMP.Model)
             upper_bound = n.location.sizes[2].capacity
         ) for n in values(graph.process_nodes), t = 1:T
     )
-    model[:expansion] = Dict(
+    model[:expansion] = Dict{Tuple,Any}(
         (n, t) => @variable(
             model,
             lower_bound = 0,
             upper_bound = n.location.sizes[2].capacity - n.location.sizes[1].capacity
         ) for n in values(graph.process_nodes), t = 1:T
     )
+
+    # Boundary constants
+    for n in values(graph.process_nodes)
+        m_init = n.location.initial_capacity
+        m_min = n.location.sizes[1].capacity
+        model[:is_open][n, 0] = m_init == 0 ? 0 : 1
+        model[:expansion][n, 0] = max(0, m_init - m_min)
+    end
 end
 
 
@@ -128,17 +140,35 @@ function create_objective_function!(model::JuMP.Model)
             )
         else
             add_to_expression!(obj, slope_open(n.location, t), model[:expansion][n, t])
+            add_to_expression!(obj, -slope_open(n.location, 1) * model[:expansion][n, 0])
         end
     end
 
-    # Shipping node costs
+    # Plant shipping node costs
     for n in values(graph.plant_shipping_nodes), t = 1:T
 
         # Disposal costs
         add_to_expression!(
             obj,
             n.location.disposal_cost[n.product][t],
-            model[:dispose][n, t],
+            model[:plant_dispose][n, t],
+        )
+    end
+
+    # Collection shipping node costs
+    for n in values(graph.collection_shipping_nodes), t = 1:T
+
+        # Acquisition costs
+        add_to_expression!(
+            obj,
+            n.location.product.acquisition_cost[t] * n.location.amount[t],
+        )
+
+        # Disposal costs -- in this case, we recover the acquisition cost.
+        add_to_expression!(
+            obj,
+            (n.location.product.disposal_cost[t] - n.location.product.acquisition_cost[t]),
+            model[:collection_dispose][n, t],
         )
     end
 
@@ -154,16 +184,29 @@ function create_shipping_node_constraints!(model::JuMP.Model)
         for n in graph.collection_shipping_nodes
             model[:eq_balance][n, t] = @constraint(
                 model,
-                sum(model[:flow][a, t] for a in n.outgoing_arcs) == n.location.amount[t]
+                sum(model[:flow][a, t] for a in n.outgoing_arcs) +
+                model[:collection_dispose][n, t] == n.location.amount[t]
             )
         end
+        for prod in model[:instance].products
+            if isempty(prod.collection_centers)
+                continue
+            end
+            expr = AffExpr()
+            for center in prod.collection_centers
+                n = graph.collection_center_to_node[center]
+                add_to_expression!(expr, model[:collection_dispose][n, t])
+            end
+            @constraint(model, expr <= prod.disposal_limit[t])
+        end
 
         # Plants
         for n in graph.plant_shipping_nodes
             @constraint(
                 model,
                 sum(model[:flow][a, t] for a in n.incoming_arcs) ==
-                sum(model[:flow][a, t] for a in n.outgoing_arcs) + model[:dispose][n, t]
+                sum(model[:flow][a, t] for a in n.outgoing_arcs) +
+                model[:plant_dispose][n, t]
             )
         end
     end
@@ -194,6 +237,12 @@ function create_process_node_constraints!(model::JuMP.Model)
             model[:capacity][n, t] <= n.location.sizes[2].capacity * model[:is_open][n, t]
         )
 
+        # If plant is closed, storage cannot be used
+        @constraint(
+            model,
+            model[:store][n, t] <= n.location.storage_limit * model[:is_open][n, t]
+        )
+
         # If plant is open, capacity is greater than base
         @constraint(
             model,
@@ -210,11 +259,11 @@ function create_process_node_constraints!(model::JuMP.Model)
         # Can only process up to capacity
         @constraint(model, model[:process][n, t] <= model[:capacity][n, t])
 
+        # Plant capacity can only increase over time
         if t > 1
-            # Plant capacity can only increase over time
             @constraint(model, model[:capacity][n, t] >= model[:capacity][n, t-1])
-            @constraint(model, model[:expansion][n, t] >= model[:expansion][n, t-1])
         end
+        @constraint(model, model[:expansion][n, t] >= model[:expansion][n, t-1])
 
         # Amount received equals amount processed plus stored
         store_in = 0
@@ -232,14 +281,10 @@ function create_process_node_constraints!(model::JuMP.Model)
 
         # Plant is currently open if it was already open in the previous time period or
         # if it was built just now
-        if t > 1
-            @constraint(
-                model,
-                model[:is_open][n, t] == model[:is_open][n, t-1] + model[:open_plant][n, t]
-            )
-        else
-            @constraint(model, model[:is_open][n, t] == model[:open_plant][n, t])
-        end
+        @constraint(
+            model,
+            model[:is_open][n, t] == model[:is_open][n, t-1] + model[:open_plant][n, t]
+        )
 
         # Plant can only be opened during building period
         if t ∉ model[:instance].building_period

src/model/getsol.jl

@@ -2,7 +2,7 @@
 # Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
 # Released under the modified BSD license. See COPYING.md for more details.
 
-using JuMP, LinearAlgebra, Geodesy, Cbc, Clp, ProgressBars, Printf, DataStructures
+using JuMP, LinearAlgebra, Geodesy, ProgressBars, Printf, DataStructures
 
 function get_solution(model::JuMP.Model; marginal_costs = true)
     graph, instance = model[:graph], model[:instance]
@@ -39,21 +39,33 @@ function get_solution(model::JuMP.Model; marginal_costs = true)
     end
 
     # Products
-    if marginal_costs
-        for n in graph.collection_shipping_nodes
-            location_dict = OrderedDict{Any,Any}(
-                "Marginal cost (\$/tonne)" => [
-                    round(abs(JuMP.shadow_price(model[:eq_balance][n, t])), digits = 2) for t = 1:T
-                ],
-                "Latitude (deg)" => n.location.latitude,
-                "Longitude (deg)" => n.location.longitude,
-                "Amount (tonne)" => n.location.amount,
-            )
-            if n.product.name ∉ keys(output["Products"])
-                output["Products"][n.product.name] = OrderedDict()
-            end
-            output["Products"][n.product.name][n.location.name] = location_dict
+    for n in graph.collection_shipping_nodes
+        location_dict = OrderedDict{Any,Any}(
+            "Latitude (deg)" => n.location.latitude,
+            "Longitude (deg)" => n.location.longitude,
+            "Amount (tonne)" => n.location.amount,
+            "Dispose (tonne)" =>
+                [JuMP.value(model[:collection_dispose][n, t]) for t = 1:T],
+            "Acquisition cost (\$)" => [
+                (n.location.amount[t] - JuMP.value(model[:collection_dispose][n, t])) * n.location.product.acquisition_cost[t] for t = 1:T
+            ],
+            "Disposal cost (\$)" => [
+                (
+                    JuMP.value(model[:collection_dispose][n, t]) *
+                    n.location.product.disposal_cost[t]
+                ) for t = 1:T
+            ],
+        )
+        if marginal_costs
+            location_dict["Marginal cost (\$/tonne)"] = [
+                round(abs(JuMP.shadow_price(model[:eq_balance][n, t])), digits = 2) for
+                t = 1:T
+            ]
         end
+        if n.product.name ∉ keys(output["Products"])
+            output["Products"][n.product.name] = OrderedDict()
+        end
+        output["Products"][n.product.name][n.location.name] = location_dict
     end
 
     # Plants
@@ -84,7 +96,10 @@ function get_solution(model::JuMP.Model; marginal_costs = true)
             "Expansion cost (\$)" => [
                 (
                     if t == 1
-                        slope_open(plant, t) * JuMP.value(model[:expansion][process_node, t])
+                        slope_open(plant, t) * (
+                            JuMP.value(model[:expansion][process_node, t]) -
+                            model[:expansion][process_node, 0]
+                        )
                     else
                         slope_open(plant, t) * (
                             JuMP.value(model[:expansion][process_node, t]) -
@@ -178,13 +193,14 @@ function get_solution(model::JuMP.Model; marginal_costs = true)
             plant_dict["Total output"][product_name] = zeros(T)
             plant_dict["Output"]["Send"][product_name] = product_dict = OrderedDict()
 
-            disposal_amount = [JuMP.value(model[:dispose][shipping_node, t]) for t = 1:T]
+            disposal_amount =
+                [JuMP.value(model[:plant_dispose][shipping_node, t]) for t = 1:T]
             if sum(disposal_amount) > 1e-5
                 skip_plant = false
                 plant_dict["Output"]["Dispose"][product_name] =
                     disposal_dict = OrderedDict()
                 disposal_dict["Amount (tonne)"] =
-                    [JuMP.value(model[:dispose][shipping_node, t]) for t = 1:T]
+                    [JuMP.value(model[:plant_dispose][shipping_node, t]) for t = 1:T]
                 disposal_dict["Cost (\$)"] = [
                     disposal_dict["Amount (tonne)"][t] *
                     plant.disposal_cost[shipping_node.product][t] for t = 1:T

src/model/resolve.jl

@@ -59,6 +59,7 @@ function _fix_plants!(model_old, model_new)::Nothing
 
     # Fix is_open variables
     for ((node_old, t), var_old) in model_old[:is_open]
+        t > 0 || continue
         value_old = JuMP.value(var_old)
         node_new = model_new[:graph].name_to_process_node_map[(
             node_old.location.plant_name,
@@ -84,6 +85,7 @@ function _fix_plants!(model_old, model_new)::Nothing
 
     # Fix plant expansion
     for ((node_old, t), var_old) in model_old[:expansion]
+        t > 0 || continue
         value_old = JuMP.value(var_old)
         node_new = model_new[:graph].name_to_process_node_map[(
             node_old.location.plant_name,

src/model/solve.jl

@@ -2,26 +2,26 @@
 # Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
 # Released under the modified BSD license. See COPYING.md for more details.
 
-using JuMP, LinearAlgebra, Geodesy, Cbc, Clp, ProgressBars, Printf, DataStructures
+using JuMP, LinearAlgebra, Geodesy, ProgressBars, Printf, DataStructures, HiGHS
 
 function _get_default_milp_optimizer()
-    return optimizer_with_attributes(Cbc.Optimizer, "logLevel" => 0)
+    return optimizer_with_attributes(HiGHS.Optimizer)
 end
 
 function _get_default_lp_optimizer()
-    return optimizer_with_attributes(Clp.Optimizer, "LogLevel" => 0)
+    return optimizer_with_attributes(HiGHS.Optimizer)
 end
 
 
 function _print_graph_stats(instance::Instance, graph::Graph)::Nothing
-    @info @sprintf("    %12d time periods", instance.time)
-    @info @sprintf("    %12d process nodes", length(graph.process_nodes))
-    @info @sprintf("    %12d shipping nodes (plant)", length(graph.plant_shipping_nodes))
+    @info @sprintf("%12d time periods", instance.time)
+    @info @sprintf("%12d process nodes", length(graph.process_nodes))
+    @info @sprintf("%12d shipping nodes (plant)", length(graph.plant_shipping_nodes))
     @info @sprintf(
-        "    %12d shipping nodes (collection)",
+        "%12d shipping nodes (collection)",
         length(graph.collection_shipping_nodes)
     )
-    @info @sprintf("    %12d arcs", length(graph.arcs))
+    @info @sprintf("%12d arcs", length(graph.arcs))
     return
 end
 
@@ -41,7 +41,7 @@ function solve(
         else
             # If only MIP optimizer is provided, use it as
             # LP solver too.
-            lp_optimizer = optimizer 
+            lp_optimizer = optimizer
         end
     end
 
@@ -98,7 +98,13 @@ function solve(filename::AbstractString; heuristic = false, kwargs...)
     if heuristic && instance.time > 1
         @info "Solving single-period version..."
         compressed = _compress(instance)
-        csol = solve(compressed; output = nothing, marginal_costs = false, kwargs...)
+        csol, _ = solve(
+            compressed;
+            return_model = true,
+            output = nothing,
+            marginal_costs = false,
+            kwargs...,
+        )
         @info "Filtering candidate locations..."
         selected_pairs = []
         for (plant_name, plant_dict) in csol["Plants"]

src/reports/plant_emissions.jl

@@ -24,7 +24,7 @@ function plant_emissions_report(solution)::DataFrame
                             location_name,
                             year,
                             emission_name,
-                            round(emission_amount[year], digits = 2),
+                            round(emission_amount[year], digits = 6),
                         ],
                     )
                 end

src/reports/plant_outputs.jl

@@ -30,7 +30,7 @@ function plant_outputs_report(solution)::DataFrame
                         end
                     end
                 end
-                sent = round.(sent, digits = 2)
+                sent = round.(sent, digits = 6)
 
                 disposal_amount = zeros(T)
                 disposal_cost = zeros(T)
@@ -38,8 +38,8 @@ function plant_outputs_report(solution)::DataFrame
                     disposal_amount += disposal_dict[product_name]["Amount (tonne)"]
                     disposal_cost += disposal_dict[product_name]["Cost (\$)"]
                 end
-                disposal_amount = round.(disposal_amount, digits = 2)
-                disposal_cost = round.(disposal_cost, digits = 2)
+                disposal_amount = round.(disposal_amount, digits = 6)
+                disposal_cost = round.(disposal_cost, digits = 6)
 
                 for year = 1:T
                     push!(
@@ -49,7 +49,7 @@ function plant_outputs_report(solution)::DataFrame
                             location_name,
                             year,
                             product_name,
-                            round(amount_produced[year], digits = 2),
+                            round(amount_produced[year], digits = 6),
                             sent[year],
                             disposal_amount[year],
                             disposal_cost[year],

src/reports/plants.jl

@@ -28,25 +28,25 @@ function plants_report(solution)::DataFrame
     for (plant_name, plant_dict) in solution["Plants"]
         for (location_name, location_dict) in plant_dict
             for year = 1:T
-                capacity = round(location_dict["Capacity (tonne)"][year], digits = 2)
-                received = round(location_dict["Total input (tonne)"][year], digits = 2)
-                processed = round(location_dict["Process (tonne)"][year], digits = 2)
-                in_storage = round(location_dict["Storage (tonne)"][year], digits = 2)
-                utilization_factor = round(processed / capacity * 100.0, digits = 2)
-                energy = round(location_dict["Energy (GJ)"][year], digits = 2)
+                capacity = round(location_dict["Capacity (tonne)"][year], digits = 6)
+                received = round(location_dict["Total input (tonne)"][year], digits = 6)
+                processed = round(location_dict["Process (tonne)"][year], digits = 6)
+                in_storage = round(location_dict["Storage (tonne)"][year], digits = 6)
+                utilization_factor = round(processed / capacity * 100.0, digits = 6)
+                energy = round(location_dict["Energy (GJ)"][year], digits = 6)
                 latitude = round(location_dict["Latitude (deg)"], digits = 6)
                 longitude = round(location_dict["Longitude (deg)"], digits = 6)
-                opening_cost = round(location_dict["Opening cost (\$)"][year], digits = 2)
+                opening_cost = round(location_dict["Opening cost (\$)"][year], digits = 6)
                 expansion_cost =
-                    round(location_dict["Expansion cost (\$)"][year], digits = 2)
+                    round(location_dict["Expansion cost (\$)"][year], digits = 6)
                 fixed_cost =
-                    round(location_dict["Fixed operating cost (\$)"][year], digits = 2)
+                    round(location_dict["Fixed operating cost (\$)"][year], digits = 6)
                 var_cost =
-                    round(location_dict["Variable operating cost (\$)"][year], digits = 2)
-                storage_cost = round(location_dict["Storage cost (\$)"][year], digits = 2)
+                    round(location_dict["Variable operating cost (\$)"][year], digits = 6)
+                storage_cost = round(location_dict["Storage cost (\$)"][year], digits = 6)
                 total_cost = round(
                     opening_cost + expansion_cost + fixed_cost + var_cost + storage_cost,
-                    digits = 2,
+                    digits = 6,
                 )
                 push!(
                     df,

src/reports/products.jl

@@ -13,7 +13,10 @@ function products_report(solution; marginal_costs = true)::DataFrame
     df."longitude (deg)" = Float64[]
     df."year" = Int[]
     df."amount (tonne)" = Float64[]
+    df."amount disposed (tonne)" = Float64[]
     df."marginal cost (\$/tonne)" = Float64[]
+    df."acquisition cost (\$)" = Float64[]
+    df."disposal cost (\$)" = Float64[]
     T = length(solution["Energy"]["Plants (GJ)"])
     for (prod_name, prod_dict) in solution["Products"]
         for (location_name, location_dict) in prod_dict
@@ -22,6 +25,9 @@ function products_report(solution; marginal_costs = true)::DataFrame
                 latitude = round(location_dict["Latitude (deg)"], digits = 6)
                 longitude = round(location_dict["Longitude (deg)"], digits = 6)
                 amount = location_dict["Amount (tonne)"][year]
+                amount_disposed = location_dict["Dispose (tonne)"][year]
+                acquisition_cost = location_dict["Acquisition cost (\$)"][year]
+                disposal_cost = location_dict["Disposal cost (\$)"][year]
                 push!(
                     df,
                     [
@@ -31,7 +37,10 @@ function products_report(solution; marginal_costs = true)::DataFrame
                         longitude,
                         year,
                         amount,
+                        amount_disposed,
                         marginal_cost,
+                        acquisition_cost,
+                        disposal_cost,
                     ],
                 )
             end

src/reports/tr.jl

@@ -42,24 +42,24 @@ function transportation_report(solution)::DataFrame
                                 round(dst_location_dict["Longitude (deg)"], digits = 6),
                                 dst_location_dict["Input product"],
                                 year,
-                                round(src_location_dict["Distance (km)"], digits = 2),
+                                round(src_location_dict["Distance (km)"], digits = 6),
                                 round(
                                     src_location_dict["Amount (tonne)"][year],
-                                    digits = 2,
+                                    digits = 6,
                                 ),
                                 round(
                                     src_location_dict["Amount (tonne)"][year] *
                                     src_location_dict["Distance (km)"],
-                                    digits = 2,
+                                    digits = 6,
                                 ),
                                 round(
                                     src_location_dict["Transportation cost (\$)"][year],
-                                    digits = 2,
+                                    digits = 6,
                                 ),
                                 round(
                                     src_location_dict["Transportation energy (J)"][year] /
                                     1e9,
-                                    digits = 2,
+                                    digits = 6,
                                 ),
                             ],
                         )

src/reports/tr_emissions.jl

@@ -44,18 +44,18 @@ function transportation_emissions_report(solution)::DataFrame
                                     round(dst_location_dict["Longitude (deg)"], digits = 6),
                                     dst_location_dict["Input product"],
                                     year,
-                                    round(src_location_dict["Distance (km)"], digits = 2),
+                                    round(src_location_dict["Distance (km)"], digits = 6),
                                     round(
                                         src_location_dict["Amount (tonne)"][year],
-                                        digits = 2,
+                                        digits = 6,
                                     ),
                                     round(
                                         src_location_dict["Amount (tonne)"][year] *
                                         src_location_dict["Distance (km)"],
-                                        digits = 2,
+                                        digits = 6,
                                     ),
                                     emission_name,
-                                    round(emission_amount[year], digits = 2),
+                                    round(emission_amount[year], digits = 6),
                                 ],
                             )
                         end

src/reports/write.jl

@@ -12,3 +12,13 @@ function write(solution::AbstractDict, filename::AbstractString)
         JSON.print(file, solution, 2)
     end
 end
+
+function write_reports(solution::AbstractDict, basename::AbstractString)
+    RELOG.write_products_report(solution, "$(basename)_products.csv")
+    RELOG.write_plants_report(solution, "$(basename)_plants.csv")
+    RELOG.write_plant_outputs_report(solution, "$(basename)_plant_outputs.csv")
+    RELOG.write_plant_emissions_report(solution, "$(basename)_plant_emissions.csv")
+    RELOG.write_transportation_report(solution, "$(basename)_tr.csv")
+    RELOG.write_transportation_emissions_report(solution, "$(basename)_tr_emissions.csv")
+    return
+end

src/schemas/input.json

@@ -1,197 +1,192 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://anl-ceeesa.github.io/RELOG/input",
-    "title": "Schema for RELOG Input File",
-    "definitions": {
-        "TimeSeries": {
-            "type": "array",
-            "items": {
-                "type": "number"
-            }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://anl-ceeesa.github.io/RELOG/input",
+  "title": "Schema for RELOG Input File",
+  "definitions": {
+    "TimeSeries": {
+      "type": "array",
+      "items": {
+        "type": "number"
+      }
+    },
+    "Parameters": {
+      "type": "object",
+      "properties": {
+        "time horizon (years)": {
+          "type": "number"
         },
-        "Parameters": {
+        "distance metric": {
+          "type": "string"
+        }
+      },
+      "required": ["time horizon (years)"]
+    },
+    "Plant": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "input": {
+            "type": "string"
+          },
+          "outputs (tonne/tonne)": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "number"
+            }
+          },
+          "energy (GJ/tonne)": {
+            "$ref": "#/definitions/TimeSeries"
+          },
+          "emissions (tonne/tonne)": {
+            "type": "object",
+            "additionalProperties": {
+              "$ref": "#/definitions/TimeSeries"
+            }
+          },
+          "locations": {
+            "$ref": "#/definitions/PlantLocation"
+          }
+        },
+        "required": ["input", "locations"]
+      }
+    },
+    "PlantLocation": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "location": {
+            "type": "string"
+          },
+          "latitude (deg)": {
+            "type": "number"
+          },
+          "longitude (deg)": {
+            "type": "number"
+          },
+          "initial capacity (tonne)": {
+            "type": "number"
+          },
+          "disposal": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "object",
+              "properties": {
+                "cost ($/tonne)": {
+                  "$ref": "#/definitions/TimeSeries"
+                },
+                "limit (tonne)": {
+                  "$ref": "#/definitions/TimeSeries"
+                }
+              },
+              "required": ["cost ($/tonne)"]
+            }
+          },
+          "storage": {
             "type": "object",
             "properties": {
-                "time horizon (years)": {
-                    "type": "number"
-                }
+              "cost ($/tonne)": {
+                "$ref": "#/definitions/TimeSeries"
+              },
+              "limit (tonne)": {
+                "type": "number"
+              }
             },
-            "required": [
-                "time horizon (years)"
-            ]
-        },
-        "Plant": {
+            "required": ["cost ($/tonne)", "limit (tonne)"]
+          },
+          "capacities (tonne)": {
             "type": "object",
             "additionalProperties": {
-                "type": "object",
-                "properties": {
-                    "input": {
-                        "type": "string"
-                    },
-                    "outputs (tonne/tonne)": {
-                        "type": "object",
-                        "additionalProperties": {
-                            "type": "number"
-                        }
-                    },
-                    "energy (GJ/tonne)": {
-                        "$ref": "#/definitions/TimeSeries"
-                    },
-                    "emissions (tonne/tonne)": {
-                        "type": "object",
-                        "additionalProperties": {
-                            "$ref": "#/definitions/TimeSeries"
-                        }
-                    },
-                    "locations": {
-                        "$ref": "#/definitions/PlantLocation"
-                    }
+              "type": "object",
+              "properties": {
+                "variable operating cost ($/tonne)": {
+                  "$ref": "#/definitions/TimeSeries"
                 },
-                "required": [
-                    "input",
-                    "locations"
-                ]
+                "fixed operating cost ($)": {
+                  "$ref": "#/definitions/TimeSeries"
+                },
+                "opening cost ($)": {
+                  "$ref": "#/definitions/TimeSeries"
+                }
+              },
+              "required": [
+                "variable operating cost ($/tonne)",
+                "fixed operating cost ($)",
+                "opening cost ($)"
+              ]
             }
+          }
         },
-        "PlantLocation": {
-            "type": "object",
-            "additionalProperties": {
-                "type": "object",
-                "properties": {
-                    "location": {
-                        "type": "string"
-                    },
-                    "latitude (deg)": {
-                        "type": "number"
-                    },
-                    "longitude (deg)": {
-                        "type": "number"
-                    },
-                    "disposal": {
-                        "type": "object",
-                        "additionalProperties": {
-                            "type": "object",
-                            "properties": {
-                                "cost ($/tonne)": {
-                                    "$ref": "#/definitions/TimeSeries"
-                                },
-                                "limit (tonne)": {
-                                    "$ref": "#/definitions/TimeSeries"
-                                }
-                            },
-                            "required": [
-                                "cost ($/tonne)"
-                            ]
-                        }
-                    },
-                    "storage": {
-                        "type": "object",
-                        "properties": {
-                            "cost ($/tonne)": {
-                                "$ref": "#/definitions/TimeSeries"
-                            },
-                            "limit (tonne)": {
-                                "type": "number"
-                            }
-                        },
-                        "required": [
-                            "cost ($/tonne)",
-                            "limit (tonne)"
-                        ]
-                    },
-                    "capacities (tonne)": {
-                        "type": "object",
-                        "additionalProperties": {
-                            "type": "object",
-                            "properties": {
-                                "variable operating cost ($/tonne)": {
-                                    "$ref": "#/definitions/TimeSeries"
-                                },
-                                "fixed operating cost ($)": {
-                                    "$ref": "#/definitions/TimeSeries"
-                                },
-                                "opening cost ($)": {
-                                    "$ref": "#/definitions/TimeSeries"
-                                }
-                            },
-                            "required": [
-                                "variable operating cost ($/tonne)",
-                                "fixed operating cost ($)",
-                                "opening cost ($)"
-                            ]
-                        }
-                    }
-                },
-                "required": [
-                    "capacities (tonne)"
-                ]
-            }
-        },
-        "InitialAmount": {
-            "type": "object",
-            "additionalProperties": {
-                "type": "object",
-                "properties": {
-                    "location": {
-                        "type": "string"
-                    },
-                    "latitude (deg)": {
-                        "type": "number"
-                    },
-                    "longitude (deg)": {
-                        "type": "number"
-                    },
-                    "amount (tonne)": {
-                        "$ref": "#/definitions/TimeSeries"
-                    }
-                },
-                "required": [
-                    "amount (tonne)"
-                ]
-            }
-        },
-        "Product": {
-            "type": "object",
-            "additionalProperties": {
-                "type": "object",
-                "properties": {
-                    "transportation cost ($/km/tonne)": {
-                        "$ref": "#/definitions/TimeSeries"
-                    },
-                    "transportation energy (J/km/tonne)": {
-                        "$ref": "#/definitions/TimeSeries"
-                    },
-                    "transportation emissions (tonne/km/tonne)": {
-                        "type": "object",
-                        "additionalProperties": {
-                            "$ref": "#/definitions/TimeSeries"
-                        }
-                    },
-                    "initial amounts": {
-                        "$ref": "#/definitions/InitialAmount"
-                    }
-                },
-                "required": [
-                    "transportation cost ($/km/tonne)"
-                ]
-            }
-        }
+        "required": ["capacities (tonne)"]
+      }
     },
-    "type": "object",
-    "properties": {
-        "parameters": {
-            "$ref": "#/definitions/Parameters"
+    "InitialAmount": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "location": {
+            "type": "string"
+          },
+          "latitude (deg)": {
+            "type": "number"
+          },
+          "longitude (deg)": {
+            "type": "number"
+          },
+          "amount (tonne)": {
+            "$ref": "#/definitions/TimeSeries"
+          }
         },
-        "plants": {
-            "$ref": "#/definitions/Plant"
-        },
-        "products": {
-            "$ref": "#/definitions/Product"
-        }
+        "required": ["amount (tonne)"]
+      }
     },
-    "required": [
-        "parameters",
-        "plants",
-        "products"
-    ]
-}
+    "Product": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "transportation cost ($/km/tonne)": {
+            "$ref": "#/definitions/TimeSeries"
+          },
+          "transportation energy (J/km/tonne)": {
+            "$ref": "#/definitions/TimeSeries"
+          },
+          "transportation emissions (tonne/km/tonne)": {
+            "type": "object",
+            "additionalProperties": {
+              "$ref": "#/definitions/TimeSeries"
+            }
+          },
+          "initial amounts": {
+            "$ref": "#/definitions/InitialAmount"
+          },
+          "disposal limit (tonne)": {
+            "$ref": "#/definitions/TimeSeries"
+          },
+          "disposal cost ($/tonne)": {
+            "$ref": "#/definitions/TimeSeries"
+          },
+          "acquisition cost ($/tonne)": {
+            "$ref": "#/definitions/TimeSeries"
+          }
+        },
+        "required": ["transportation cost ($/km/tonne)"]
+      }
+    }
+  },
+  "type": "object",
+  "properties": {
+    "parameters": {
+      "$ref": "#/definitions/Parameters"
+    },
+    "plants": {
+      "$ref": "#/definitions/Plant"
+    },
+    "products": {
+      "$ref": "#/definitions/Product"
+    }
+  },
+  "required": ["parameters", "plants", "products"]
+}

src/sysimage.jl

@@ -1,15 +0,0 @@
-using PackageCompiler
-
-using Cbc
-using Clp
-using Geodesy
-using JSON
-using JSONSchema
-using JuMP
-using MathOptInterface
-using ProgressBars
-
-pkg = [:Cbc, :Clp, :Geodesy, :JSON, :JSONSchema, :JuMP, :MathOptInterface, :ProgressBars]
-
-@info "Building system image..."
-create_sysimage(pkg, sysimage_path = "build/sysimage.so")

src/web/run.jl

@@ -1,40 +1,33 @@
 println("Initializing...")
 
 using Logging
-using Cbc
-using Clp
 using JSON
 using JuMP
+using HiGHS
 using RELOG
 
 function solve(root, filename)
     ref_file = "$root/$filename"
     optimizer = optimizer_with_attributes(
-        Cbc.Optimizer,
-        "seconds" => 900,
+        HiGHS.Optimizer,
+        "time_limit" => parse(Float64, ENV["RELOG_TIME_LIMIT_SEC"]),
     )
     ref_solution, ref_model = RELOG.solve(
         ref_file,
-        optimizer=optimizer,
-        lp_optimizer=Clp.Optimizer,
-        return_model=true,
-        marginal_costs=true,
+        optimizer = optimizer,
+        lp_optimizer = HiGHS.Optimizer,
+        return_model = true,
+        marginal_costs = true,
     )
     Libc.flush_cstdio()
     flush(stdout)
     sleep(1)
-    
+
     if length(ref_solution) == 0
         return
     end
-    RELOG.write_products_report(
-        ref_solution,
-        replace(ref_file, ".json" => "_products.csv"),
-    )
-    RELOG.write_plants_report(
-        ref_solution,
-        replace(ref_file, ".json" => "_plants.csv"),
-    )
+    RELOG.write_products_report(ref_solution, replace(ref_file, ".json" => "_products.csv"))
+    RELOG.write_plants_report(ref_solution, replace(ref_file, ".json" => "_plants.csv"))
     RELOG.write_plant_outputs_report(
         ref_solution,
         replace(ref_file, ".json" => "_plant_outputs.csv"),
@@ -43,10 +36,7 @@ function solve(root, filename)
         ref_solution,
         replace(ref_file, ".json" => "_plant_emissions.csv"),
     )
-    RELOG.write_transportation_report(
-        ref_solution,
-        replace(ref_file, ".json" => "_tr.csv"),
-    )
+    RELOG.write_transportation_report(ref_solution, replace(ref_file, ".json" => "_tr.csv"))
     RELOG.write_transportation_emissions_report(
         ref_solution,
         replace(ref_file, ".json" => "_tr_emissions.csv"),
@@ -60,16 +50,13 @@ function solve(root, filename)
         sc_solution = RELOG.resolve(
             ref_model,
             scenario,
-            optimizer=optimizer,
-            lp_optimizer=Clp.Optimizer,
+            optimizer = optimizer,
+            lp_optimizer = HiGHS.Optimizer,
         )
         if length(sc_solution) == 0
             return
         end
-        RELOG.write_plants_report(
-            sc_solution,
-            replace(scenario, ".json" => "_plants.csv"),
-        )
+        RELOG.write_plants_report(sc_solution, replace(scenario, ".json" => "_plants.csv"))
         RELOG.write_products_report(
             sc_solution,
             replace(scenario, ".json" => "_products.csv"),
@@ -114,10 +101,7 @@ function solve_recursive(path)
             endswith(filename, "_plants.csv") || continue
             push!(
                 results,
-                joinpath(
-                    replace(root, path => ""),
-                    replace(filename, "_plants.csv" => ""),
-                ),
+                joinpath(replace(root, path => ""), replace(filename, "_plants.csv" => "")),
             )
         end
     end
@@ -128,4 +112,4 @@ function solve_recursive(path)
     run(`zip -r output.zip .`)
 end
 
-solve_recursive(ARGS[1])
+solve_recursive(ARGS[1])

src/web/web.jl

@@ -32,11 +32,11 @@ function submit(req::HTTP.Request)
     end
 
     # Run job
-    run(`bash -c "(julia --project=$PROJECT_DIR $PROJECT_DIR/src/web/run.jl $job_path 2>&1 | tee $job_path/solve.log) >/dev/null 2>&1 &"`)
-
-    response = Dict(
-        "job_id" => job_id,
+    run(
+        `bash -c "(julia --project=$PROJECT_DIR $PROJECT_DIR/src/web/run.jl $job_path 2>&1 | tee $job_path/solve.log) >/dev/null 2>&1 &"`,
     )
+
+    response = Dict("job_id" => job_id)
     return HTTP.Response(200, body = JSON.json(response))
 end
 
@@ -63,4 +63,3 @@ function web(host = "127.0.0.1", port = 8080)
     HTTP.serve(ROUTER, host, port)
     Base.exit_on_sigint(true)
 end
-

test/Project.toml

@@ -0,0 +1,19 @@
+name = "RELOGT"
+uuid = "a6dae211-05d8-42ed-9081-b88c982fc90a"
+authors = ["Alinson S. Xavier <git@axavier.org>"]
+version = "0.1.0"
+
+[deps]
+GZip = "92fee26a-97fe-5a0c-ad85-20a5f3185b63"
+HiGHS = "87dc4568-4c63-4d18-b0c0-bb2238e4078b"
+JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+JuMP = "4076af6c-e467-56ae-b986-b466b2749572"
+JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
+MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+RELOG = "a2afcdf7-cf04-4913-85f9-c0d81ddf2008"
+Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[compat]
+JuliaFormatter = "1"

test/fixtures/s1.json

@@ -0,0 +1,207 @@
+{
+  "parameters": {
+    "time horizon (years)": 2,
+    "distance metric": "driving"
+  },
+  "products": {
+    "P1": {
+      "transportation cost ($/km/tonne)": [0.015, 0.015],
+      "transportation energy (J/km/tonne)": [0.12, 0.11],
+      "transportation emissions (tonne/km/tonne)": {
+        "CO2": [0.052, 0.05],
+        "CH4": [0.003, 0.002]
+      },
+      "initial amounts": {
+        "C1": {
+          "latitude (deg)": 7.0,
+          "longitude (deg)": 7.0,
+          "amount (tonne)": [934.56, 934.56]
+        },
+        "C2": {
+          "latitude (deg)": 7.0,
+          "longitude (deg)": 19.0,
+          "amount (tonne)": [198.95, 198.95]
+        },
+        "C3": {
+          "latitude (deg)": 84.0,
+          "longitude (deg)": 76.0,
+          "amount (tonne)": [212.97, 212.97]
+        },
+        "C4": {
+          "latitude (deg)": 21.0,
+          "longitude (deg)": 16.0,
+          "amount (tonne)": [352.19, 352.19]
+        },
+        "C5": {
+          "latitude (deg)": 32.0,
+          "longitude (deg)": 92.0,
+          "amount (tonne)": [510.33, 510.33]
+        },
+        "C6": {
+          "latitude (deg)": 14.0,
+          "longitude (deg)": 62.0,
+          "amount (tonne)": [471.66, 471.66]
+        },
+        "C7": {
+          "latitude (deg)": 30.0,
+          "longitude (deg)": 83.0,
+          "amount (tonne)": [785.21, 785.21]
+        },
+        "C8": {
+          "latitude (deg)": 35.0,
+          "longitude (deg)": 40.0,
+          "amount (tonne)": [706.17, 706.17]
+        },
+        "C9": {
+          "latitude (deg)": 74.0,
+          "longitude (deg)": 52.0,
+          "amount (tonne)": [30.08, 30.08]
+        },
+        "C10": {
+          "latitude (deg)": 22.0,
+          "longitude (deg)": 54.0,
+          "amount (tonne)": [536.52, 536.52]
+        }
+      },
+      "disposal limit (tonne)": [1.0, 1.0],
+      "disposal cost ($/tonne)": [-1000, -1000],
+      "acquisition cost ($/tonne)": [0.5, 0.5]
+    },
+    "P2": {
+      "transportation cost ($/km/tonne)": [0.02, 0.02]
+    },
+    "P3": {
+      "transportation cost ($/km/tonne)": [0.0125, 0.0125]
+    },
+    "P4": {
+      "transportation cost ($/km/tonne)": [0.0175, 0.0175]
+    }
+  },
+  "plants": {
+    "F1": {
+      "input": "P1",
+      "outputs (tonne/tonne)": {
+        "P2": 0.2,
+        "P3": 0.5
+      },
+      "energy (GJ/tonne)": [0.12, 0.11],
+      "emissions (tonne/tonne)": {
+        "CO2": [0.052, 0.05],
+        "CH4": [0.003, 0.002]
+      },
+      "locations": {
+        "L1": {
+          "latitude (deg)": 0.0,
+          "longitude (deg)": 0.0,
+          "disposal": {
+            "P2": {
+              "cost ($/tonne)": [-10.0, -10.0],
+              "limit (tonne)": [1.0, 1.0]
+            },
+            "P3": {
+              "cost ($/tonne)": [-10.0, -10.0],
+              "limit (tonne)": [1.0, 1.0]
+            }
+          },
+          "initial capacity (tonne)": 500.0,
+          "capacities (tonne)": {
+            "250.0": {
+              "opening cost ($)": [500.0, 500.0],
+              "fixed operating cost ($)": [30.0, 30.0],
+              "variable operating cost ($/tonne)": [30.0, 30.0]
+            },
+            "1000.0": {
+              "opening cost ($)": [1250.0, 1250.0],
+              "fixed operating cost ($)": [30.0, 30.0],
+              "variable operating cost ($/tonne)": [30.0, 30.0]
+            }
+          }
+        },
+        "L2": {
+          "latitude (deg)": 0.5,
+          "longitude (deg)": 0.5,
+          "capacities (tonne)": {
+            "0.0": {
+              "opening cost ($)": [1000, 1000],
+              "fixed operating cost ($)": [50.0, 50.0],
+              "variable operating cost ($/tonne)": [50.0, 50.0]
+            },
+            "10000.0": {
+              "opening cost ($)": [10000, 10000],
+              "fixed operating cost ($)": [50.0, 50.0],
+              "variable operating cost ($/tonne)": [50.0, 50.0]
+            }
+          }
+        }
+      }
+    },
+    "F2": {
+      "input": "P2",
+      "outputs (tonne/tonne)": {
+        "P3": 0.05,
+        "P4": 0.8
+      },
+      "locations": {
+        "L3": {
+          "latitude (deg)": 25.0,
+          "longitude (deg)": 65.0,
+          "disposal": {
+            "P3": {
+              "cost ($/tonne)": [100.0, 100.0]
+            }
+          },
+          "capacities (tonne)": {
+            "1000.0": {
+              "opening cost ($)": [3000, 3000],
+              "fixed operating cost ($)": [50.0, 50.0],
+              "variable operating cost ($/tonne)": [50.0, 50.0]
+            }
+          }
+        },
+        "L4": {
+          "latitude (deg)": 0.75,
+          "longitude (deg)": 0.2,
+          "capacities (tonne)": {
+            "10000": {
+              "opening cost ($)": [3000, 3000],
+              "fixed operating cost ($)": [50.0, 50.0],
+              "variable operating cost ($/tonne)": [50.0, 50.0]
+            }
+          }
+        }
+      }
+    },
+    "F3": {
+      "input": "P4",
+      "locations": {
+        "L5": {
+          "latitude (deg)": 100.0,
+          "longitude (deg)": 100.0,
+          "capacities (tonne)": {
+            "15000": {
+              "opening cost ($)": [0.0, 0.0],
+              "fixed operating cost ($)": [0.0, 0.0],
+              "variable operating cost ($/tonne)": [-15.0, -15.0]
+            }
+          }
+        }
+      }
+    },
+    "F4": {
+      "input": "P3",
+      "locations": {
+        "L6": {
+          "latitude (deg)": 50.0,
+          "longitude (deg)": 50.0,
+          "capacities (tonne)": {
+            "10000": {
+              "opening cost ($)": [0.0, 0.0],
+              "fixed operating cost ($)": [0.0, 0.0],
+              "variable operating cost ($/tonne)": [-15.0, -15.0]
+            }
+          }
+        }
+      }
+    }
+  }
+}

test/graph/build_test.jl

@@ -1,39 +0,0 @@
-# Copyright (C) 2020 Argonne National Laboratory
-# Written by Alinson Santos Xavier <axavier@anl.gov>
-
-using RELOG
-
-@testset "build_graph" begin
-    basedir = dirname(@__FILE__)
-    instance = RELOG.parsefile("$basedir/../../instances/s1.json")
-    graph = RELOG.build_graph(instance)
-    process_node_by_location_name =
-        Dict(n.location.location_name => n for n in graph.process_nodes)
-
-    @test length(graph.plant_shipping_nodes) == 8
-    @test length(graph.collection_shipping_nodes) == 10
-    @test length(graph.process_nodes) == 6
-
-    node = graph.collection_shipping_nodes[1]
-    @test node.location.name == "C1"
-    @test length(node.incoming_arcs) == 0
-    @test length(node.outgoing_arcs) == 2
-    @test node.outgoing_arcs[1].source.location.name == "C1"
-    @test node.outgoing_arcs[1].dest.location.plant_name == "F1"
-    @test node.outgoing_arcs[1].dest.location.location_name == "L1"
-    @test node.outgoing_arcs[1].values["distance"] == 1095.62
-
-    node = process_node_by_location_name["L1"]
-    @test node.location.plant_name == "F1"
-    @test node.location.location_name == "L1"
-    @test length(node.incoming_arcs) == 10
-    @test length(node.outgoing_arcs) == 2
-
-    node = process_node_by_location_name["L3"]
-    @test node.location.plant_name == "F2"
-    @test node.location.location_name == "L3"
-    @test length(node.incoming_arcs) == 2
-    @test length(node.outgoing_arcs) == 2
-
-    @test length(graph.arcs) == 38
-end

test/instance/compress_test.jl

@@ -1,53 +0,0 @@
-# Copyright (C) 2020 Argonne National Laboratory
-# Written by Alinson Santos Xavier <axavier@anl.gov>
-
-using RELOG
-
-@testset "compress" begin
-    basedir = dirname(@__FILE__)
-    instance = RELOG.parsefile("$basedir/../../instances/s1.json")
-    compressed = RELOG._compress(instance)
-
-    product_name_to_product = Dict(p.name => p for p in compressed.products)
-    location_name_to_facility = Dict()
-    for p in compressed.plants
-        location_name_to_facility[p.location_name] = p
-    end
-    for c in compressed.collection_centers
-        location_name_to_facility[c.name] = c
-    end
-
-    p1 = product_name_to_product["P1"]
-    p2 = product_name_to_product["P2"]
-    p3 = product_name_to_product["P3"]
-    c1 = location_name_to_facility["C1"]
-    l1 = location_name_to_facility["L1"]
-
-    @test compressed.time == 1
-    @test compressed.building_period == [1]
-
-    @test p1.name == "P1"
-    @test p1.transportation_cost ≈ [0.015]
-    @test p1.transportation_energy ≈ [0.115]
-    @test p1.transportation_emissions["CO2"] ≈ [0.051]
-    @test p1.transportation_emissions["CH4"] ≈ [0.0025]
-
-    @test c1.name == "C1"
-    @test c1.amount ≈ [1869.12]
-
-    @test l1.plant_name == "F1"
-    @test l1.location_name == "L1"
-    @test l1.energy ≈ [0.115]
-    @test l1.emissions["CO2"] ≈ [0.051]
-    @test l1.emissions["CH4"] ≈ [0.0025]
-    @test l1.sizes[1].opening_cost ≈ [500]
-    @test l1.sizes[2].opening_cost ≈ [1250]
-    @test l1.sizes[1].fixed_operating_cost ≈ [60]
-    @test l1.sizes[2].fixed_operating_cost ≈ [60]
-    @test l1.sizes[1].variable_operating_cost ≈ [30]
-    @test l1.sizes[2].variable_operating_cost ≈ [30]
-    @test l1.disposal_limit[p2] ≈ [2.0]
-    @test l1.disposal_limit[p3] ≈ [2.0]
-    @test l1.disposal_cost[p2] ≈ [-10.0]
-    @test l1.disposal_cost[p3] ≈ [-10.0]
-end

test/instance/geodb_test.jl

@@ -1,25 +0,0 @@
-# RELOG: Reverse Logistics Optimization
-# Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
-# Released under the modified BSD license. See COPYING.md for more details.
-
-using RELOG
-
-@testset "geodb_query (2018-us-county)" begin
-    region = RELOG.geodb_query("2018-us-county:17043")
-    @test region.centroid.lat == 41.83956
-    @test region.centroid.lon == -88.08857
-    @test region.population == 922_921
-end
-
-# @testset "geodb_query (2018-us-zcta)" begin
-#     region = RELOG.geodb_query("2018-us-zcta:60439")
-#     @test region.centroid.lat == 41.68241
-#     @test region.centroid.lon == -87.98954
-# end
-
-@testset "geodb_query (us-state)" begin
-    region = RELOG.geodb_query("us-state:IL")
-    @test region.centroid.lat == 39.73939
-    @test region.centroid.lon == -89.50414
-    @test region.population == 12_671_821
-end

test/instance/parse_test.jl

@@ -1,86 +0,0 @@
-# Copyright (C) 2020 Argonne National Laboratory
-# Written by Alinson Santos Xavier <axavier@anl.gov>
-
-using RELOG
-
-@testset "parse" begin
-    basedir = dirname(@__FILE__)
-    instance = RELOG.parsefile("$basedir/../../instances/s1.json")
-
-    centers = instance.collection_centers
-    plants = instance.plants
-    products = instance.products
-    location_name_to_plant = Dict(p.location_name => p for p in plants)
-    product_name_to_product = Dict(p.name => p for p in products)
-
-    @test length(centers) == 10
-    @test centers[1].name == "C1"
-    @test centers[1].latitude == 7
-    @test centers[1].latitude == 7
-    @test centers[1].longitude == 7
-    @test centers[1].amount == [934.56, 934.56]
-    @test centers[1].product.name == "P1"
-
-    @test length(plants) == 6
-
-    plant = location_name_to_plant["L1"]
-    @test plant.plant_name == "F1"
-    @test plant.location_name == "L1"
-    @test plant.input.name == "P1"
-    @test plant.latitude == 0
-    @test plant.longitude == 0
-
-    @test length(plant.sizes) == 2
-    @test plant.sizes[1].capacity == 250
-    @test plant.sizes[1].opening_cost == [500, 500]
-    @test plant.sizes[1].fixed_operating_cost == [30, 30]
-    @test plant.sizes[1].variable_operating_cost == [30, 30]
-    @test plant.sizes[2].capacity == 1000
-    @test plant.sizes[2].opening_cost == [1250, 1250]
-    @test plant.sizes[2].fixed_operating_cost == [30, 30]
-    @test plant.sizes[2].variable_operating_cost == [30, 30]
-
-    p2 = product_name_to_product["P2"]
-    p3 = product_name_to_product["P3"]
-    @test length(plant.output) == 2
-    @test plant.output[p2] == 0.2
-    @test plant.output[p3] == 0.5
-    @test plant.disposal_limit[p2] == [1, 1]
-    @test plant.disposal_limit[p3] == [1, 1]
-    @test plant.disposal_cost[p2] == [-10, -10]
-    @test plant.disposal_cost[p3] == [-10, -10]
-
-    plant = location_name_to_plant["L3"]
-    @test plant.location_name == "L3"
-    @test plant.input.name == "P2"
-    @test plant.latitude == 25
-    @test plant.longitude == 65
-
-    @test length(plant.sizes) == 2
-    @test plant.sizes[1].capacity == 1000.0
-    @test plant.sizes[1].opening_cost == [3000, 3000]
-    @test plant.sizes[1].fixed_operating_cost == [50, 50]
-    @test plant.sizes[1].variable_operating_cost == [50, 50]
-    @test plant.sizes[1] == plant.sizes[2]
-
-    p4 = product_name_to_product["P4"]
-    @test plant.output[p3] == 0.05
-    @test plant.output[p4] == 0.8
-    @test plant.disposal_limit[p3] == [1e8, 1e8]
-    @test plant.disposal_limit[p4] == [0, 0]
-end
-
-@testset "parse (geodb)" begin
-    basedir = dirname(@__FILE__)
-    instance = RELOG.parsefile("$basedir/../../instances/s2.json")
-
-    centers = instance.collection_centers
-    @test centers[1].name == "C1"
-    @test centers[1].latitude == 41.83956
-    @test centers[1].longitude == -88.08857
-end
-
-# @testset "parse (invalid)" begin
-#     basedir = dirname(@__FILE__)
-#     @test_throws ErrorException RELOG.parsefile("$basedir/../fixtures/s1-wrong-length.json")
-# end

test/model/build_test.jl

@@ -1,38 +0,0 @@
-# Copyright (C) 2020 Argonne National Laboratory
-# Written by Alinson Santos Xavier <axavier@anl.gov>
-
-using RELOG, Cbc, JuMP, Printf, JSON, MathOptInterface.FileFormats
-
-@testset "build" begin
-    basedir = dirname(@__FILE__)
-    instance = RELOG.parsefile("$basedir/../../instances/s1.json")
-    graph = RELOG.build_graph(instance)
-    model = RELOG.build_model(instance, graph, Cbc.Optimizer)
-    set_optimizer_attribute(model, "logLevel", 0)
-
-    process_node_by_location_name =
-        Dict(n.location.location_name => n for n in graph.process_nodes)
-
-    shipping_node_by_loc_and_prod_names = Dict(
-        (n.location.location_name, n.product.name) => n for n in graph.plant_shipping_nodes
-    )
-
-    @test length(model[:flow]) == 76
-    @test length(model[:dispose]) == 16
-    @test length(model[:open_plant]) == 12
-    @test length(model[:capacity]) == 12
-    @test length(model[:expansion]) == 12
-
-    l1 = process_node_by_location_name["L1"]
-    v = model[:capacity][l1, 1]
-    @test lower_bound(v) == 0.0
-    @test upper_bound(v) == 1000.0
-
-    v = model[:expansion][l1, 1]
-    @test lower_bound(v) == 0.0
-    @test upper_bound(v) == 750.0
-
-    v = model[:dispose][shipping_node_by_loc_and_prod_names["L1", "P2"], 1]
-    @test lower_bound(v) == 0.0
-    @test upper_bound(v) == 1.0
-end

test/model/resolve_test.jl

@@ -1,13 +0,0 @@
-# Copyright (C) 2020 Argonne National Laboratory
-# Written by Alinson Santos Xavier <axavier@anl.gov>
-
-using RELOG
-
-BASEDIR = dirname(@__FILE__)
-
-@testset "Resolve" begin
-    # Shoud not crash
-    filename = joinpath(BASEDIR, "..", "..", "instances", "s1.json")
-    solution_old, model_old = RELOG.solve(filename, return_model = true)
-    solution_new = RELOG.resolve(model_old, filename)
-end

test/model/solve_test.jl

@@ -1,61 +0,0 @@
-# Copyright (C) 2020 Argonne National Laboratory
-# Written by Alinson Santos Xavier <axavier@anl.gov>
-
-using RELOG, Cbc, JuMP, Printf, JSON, MathOptInterface.FileFormats
-
-basedir = dirname(@__FILE__)
-
-@testset "solve (exact)" begin
-    solution_filename_a = tempname()
-    solution_filename_b = tempname()
-    solution = RELOG.solve("$basedir/../../instances/s1.json", output = solution_filename_a)
-
-    @test isfile(solution_filename_a)
-
-    RELOG.write(solution, solution_filename_b)
-    @test isfile(solution_filename_b)
-
-    @test "Costs" in keys(solution)
-    @test "Fixed operating (\$)" in keys(solution["Costs"])
-    @test "Transportation (\$)" in keys(solution["Costs"])
-    @test "Variable operating (\$)" in keys(solution["Costs"])
-    @test "Total (\$)" in keys(solution["Costs"])
-
-    @test "Plants" in keys(solution)
-    @test "F1" in keys(solution["Plants"])
-    @test "F2" in keys(solution["Plants"])
-    @test "F3" in keys(solution["Plants"])
-    @test "F4" in keys(solution["Plants"])
-end
-
-@testset "solve (heuristic)" begin
-    # Should not crash
-    solution = RELOG.solve("$basedir/../../instances/s1.json", heuristic = true)
-end
-
-@testset "solve (infeasible)" begin
-    json = JSON.parsefile("$basedir/../../instances/s1.json")
-    for (location_name, location_dict) in json["products"]["P1"]["initial amounts"]
-        location_dict["amount (tonne)"] *= 1000
-    end
-    @test_throws ErrorException("No solution available") RELOG.solve(RELOG.parse(json))
-end
-
-@testset "solve (with storage)" begin
-    basedir = dirname(@__FILE__)
-    filename = "$basedir/../fixtures/storage.json"
-    instance = RELOG.parsefile(filename)
-    @test instance.plants[1].storage_limit == 50.0
-    @test instance.plants[1].storage_cost == [2.0, 1.5, 1.0]
-
-    solution = RELOG.solve(filename)
-    plant_dict = solution["Plants"]["mega plant"]["Chicago"]
-    @test plant_dict["Variable operating cost (\$)"] == [500.0, 0.0, 100.0]
-    @test plant_dict["Process (tonne)"] == [50.0, 0.0, 50.0]
-    @test plant_dict["Storage (tonne)"] == [50.0, 50.0, 0.0]
-    @test plant_dict["Storage cost (\$)"] == [100.0, 75.0, 0.0]
-
-    @test solution["Costs"]["Variable operating (\$)"] == [500.0, 0.0, 100.0]
-    @test solution["Costs"]["Storage (\$)"] == [100.0, 75.0, 0.0]
-    @test solution["Costs"]["Total (\$)"] == [600.0, 75.0, 100.0]
-end

test/reports_test.jl

@@ -1,21 +0,0 @@
-# RELOG: Reverse Logistics Optimization
-# Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
-# Released under the modified BSD license. See COPYING.md for more details.
-
-using RELOG, JSON, GZip
-
-BASEDIR = dirname(@__FILE__)
-
-@testset "Reports" begin
-    @testset "from solve" begin
-        solution = RELOG.solve(joinpath(BASEDIR, "..", "instances", "s1.json"))
-        tmp_filename = tempname()
-        # The following should not crash
-        RELOG.write_plant_emissions_report(solution, tmp_filename)
-        RELOG.write_plant_outputs_report(solution, tmp_filename)
-        RELOG.write_plants_report(solution, tmp_filename)
-        RELOG.write_products_report(solution, tmp_filename)
-        RELOG.write_transportation_emissions_report(solution, tmp_filename)
-        RELOG.write_transportation_report(solution, tmp_filename)
-    end
-end

test/runtests.jl

@@ -1,21 +0,0 @@
-# Copyright (C) 2020 Argonne National Laboratory
-# Written by Alinson Santos Xavier <axavier@anl.gov>
-
-using Test
-
-@testset "RELOG" begin
-    @testset "Instance" begin
-        include("instance/compress_test.jl")
-        include("instance/geodb_test.jl")
-        include("instance/parse_test.jl")
-    end
-    @testset "Graph" begin
-        include("graph/build_test.jl")
-    end
-    @testset "Model" begin
-        include("model/build_test.jl")
-        include("model/solve_test.jl")
-        include("model/resolve_test.jl")
-    end
-    include("reports_test.jl")
-end

test/src/RELOGT.jl

@@ -0,0 +1,51 @@
+module RELOGT
+
+using Test
+using JuliaFormatter
+
+include("instance/compress_test.jl")
+include("instance/geodb_test.jl")
+include("instance/parse_test.jl")
+include("graph/build_test.jl")
+include("graph/dist_test.jl")
+include("model/build_test.jl")
+include("model/solve_test.jl")
+include("model/resolve_test.jl")
+include("reports_test.jl")
+
+basedir = dirname(@__FILE__)
+
+function fixture(path::String)::String
+    return "$basedir/../fixtures/$path"
+end
+
+function runtests()
+    @testset "RELOG" begin
+        @testset "instance" begin
+            instance_compress_test()
+            instance_geodb_test()
+            instance_parse_test()
+        end
+        @testset "graph" begin
+            graph_build_test()
+            graph_dist_test()
+        end
+        @testset "model" begin
+            model_build_test()
+            model_solve_test()
+            model_resolve_test()
+        end
+        reports_test()
+    end
+    return
+end
+
+function format()
+    JuliaFormatter.format(basedir, verbose = true)
+    JuliaFormatter.format("$basedir/../../src", verbose = true)
+    return
+end
+
+export runtests, format
+
+end # module RELOGT

test/src/graph/build_test.jl

@@ -0,0 +1,40 @@
+# Copyright (C) 2020 Argonne National Laboratory
+# Written by Alinson Santos Xavier <axavier@anl.gov>
+
+using RELOG
+
+function graph_build_test()
+    @testset "build_graph" begin
+        instance = RELOG.parsefile(fixture("s1.json"))
+        graph = RELOG.build_graph(instance)
+        process_node_by_location_name =
+            Dict(n.location.location_name => n for n in graph.process_nodes)
+
+        @test length(graph.plant_shipping_nodes) == 8
+        @test length(graph.collection_shipping_nodes) == 10
+        @test length(graph.process_nodes) == 6
+
+        node = graph.collection_shipping_nodes[1]
+        @test node.location.name == "C1"
+        @test length(node.incoming_arcs) == 0
+        @test length(node.outgoing_arcs) == 2
+        @test node.outgoing_arcs[1].source.location.name == "C1"
+        @test node.outgoing_arcs[1].dest.location.plant_name == "F1"
+        @test node.outgoing_arcs[1].dest.location.location_name == "L1"
+        @test node.outgoing_arcs[1].values["distance"] == 1695.364
+
+        node = process_node_by_location_name["L1"]
+        @test node.location.plant_name == "F1"
+        @test node.location.location_name == "L1"
+        @test length(node.incoming_arcs) == 10
+        @test length(node.outgoing_arcs) == 2
+
+        node = process_node_by_location_name["L3"]
+        @test node.location.plant_name == "F2"
+        @test node.location.location_name == "L3"
+        @test length(node.incoming_arcs) == 2
+        @test length(node.outgoing_arcs) == 2
+
+        @test length(graph.arcs) == 38
+    end
+end

test/src/graph/dist_test.jl

@@ -0,0 +1,27 @@
+# RELOG: Reverse Logistics Optimization
+# Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
+# Released under the modified BSD license. See COPYING.md for more details.
+
+using RELOG
+
+function graph_dist_test()
+    @testset "KnnDrivingDistance" begin
+        # Euclidean distance between Chicago and Indianapolis
+        @test RELOG._calculate_distance(
+            41.866,
+            -87.656,
+            39.764,
+            -86.148,
+            RELOG.EuclideanDistance(),
+        ) == 265.818
+
+        # Approximate driving distance between Chicago and Indianapolis
+        @test RELOG._calculate_distance(
+            41.866,
+            -87.656,
+            39.764,
+            -86.148,
+            RELOG.KnnDrivingDistance(),
+        ) == 316.43
+    end
+end

test/src/instance/compress_test.jl

@@ -0,0 +1,54 @@
+# Copyright (C) 2020 Argonne National Laboratory
+# Written by Alinson Santos Xavier <axavier@anl.gov>
+
+using RELOG
+
+function instance_compress_test()
+    @testset "compress" begin
+        instance = RELOG.parsefile(fixture("s1.json"))
+        compressed = RELOG._compress(instance)
+
+        product_name_to_product = Dict(p.name => p for p in compressed.products)
+        location_name_to_facility = Dict()
+        for p in compressed.plants
+            location_name_to_facility[p.location_name] = p
+        end
+        for c in compressed.collection_centers
+            location_name_to_facility[c.name] = c
+        end
+
+        p1 = product_name_to_product["P1"]
+        p2 = product_name_to_product["P2"]
+        p3 = product_name_to_product["P3"]
+        c1 = location_name_to_facility["C1"]
+        l1 = location_name_to_facility["L1"]
+
+        @test compressed.time == 1
+        @test compressed.building_period == [1]
+
+        @test p1.name == "P1"
+        @test p1.transportation_cost ≈ [0.015]
+        @test p1.transportation_energy ≈ [0.115]
+        @test p1.transportation_emissions["CO2"] ≈ [0.051]
+        @test p1.transportation_emissions["CH4"] ≈ [0.0025]
+
+        @test c1.name == "C1"
+        @test c1.amount ≈ [1869.12]
+
+        @test l1.plant_name == "F1"
+        @test l1.location_name == "L1"
+        @test l1.energy ≈ [0.115]
+        @test l1.emissions["CO2"] ≈ [0.051]
+        @test l1.emissions["CH4"] ≈ [0.0025]
+        @test l1.sizes[1].opening_cost ≈ [500]
+        @test l1.sizes[2].opening_cost ≈ [1250]
+        @test l1.sizes[1].fixed_operating_cost ≈ [60]
+        @test l1.sizes[2].fixed_operating_cost ≈ [60]
+        @test l1.sizes[1].variable_operating_cost ≈ [30]
+        @test l1.sizes[2].variable_operating_cost ≈ [30]
+        @test l1.disposal_limit[p2] ≈ [2.0]
+        @test l1.disposal_limit[p3] ≈ [2.0]
+        @test l1.disposal_cost[p2] ≈ [-10.0]
+        @test l1.disposal_cost[p3] ≈ [-10.0]
+    end
+end

test/src/instance/geodb_test.jl

@@ -0,0 +1,27 @@
+# RELOG: Reverse Logistics Optimization
+# Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
+# Released under the modified BSD license. See COPYING.md for more details.
+
+using RELOG
+
+function instance_geodb_test()
+    @testset "geodb_query (2018-us-county)" begin
+        region = RELOG.geodb_query("2018-us-county:17043")
+        @test region.centroid.lat == 41.83956
+        @test region.centroid.lon == -88.08857
+        @test region.population == 922_921
+    end
+
+    # @testset "geodb_query (2018-us-zcta)" begin
+    #     region = RELOG.geodb_query("2018-us-zcta:60439")
+    #     @test region.centroid.lat == 41.68241
+    #     @test region.centroid.lon == -87.98954
+    # end
+
+    @testset "geodb_query (us-state)" begin
+        region = RELOG.geodb_query("us-state:IL")
+        @test region.centroid.lat == 39.73939
+        @test region.centroid.lon == -89.50414
+        @test region.population == 12_671_821
+    end
+end

test/src/instance/parse_test.jl

@@ -0,0 +1,91 @@
+# Copyright (C) 2020 Argonne National Laboratory
+# Written by Alinson Santos Xavier <axavier@anl.gov>
+
+using RELOG
+
+function instance_parse_test()
+    @testset "parse" begin
+        instance = RELOG.parsefile(fixture("s1.json"))
+
+        centers = instance.collection_centers
+        plants = instance.plants
+        products = instance.products
+        location_name_to_plant = Dict(p.location_name => p for p in plants)
+        product_name_to_product = Dict(p.name => p for p in products)
+
+        @test length(centers) == 10
+        @test centers[1].name == "C1"
+        @test centers[1].latitude == 7
+        @test centers[1].latitude == 7
+        @test centers[1].longitude == 7
+        @test centers[1].amount == [934.56, 934.56]
+        @test centers[1].product.name == "P1"
+
+        @test length(plants) == 6
+
+        plant = location_name_to_plant["L1"]
+        @test plant.plant_name == "F1"
+        @test plant.location_name == "L1"
+        @test plant.input.name == "P1"
+        @test plant.latitude == 0
+        @test plant.longitude == 0
+        @test plant.initial_capacity == 500.0
+
+        @test length(plant.sizes) == 2
+        @test plant.sizes[1].capacity == 250
+        @test plant.sizes[1].opening_cost == [500, 500]
+        @test plant.sizes[1].fixed_operating_cost == [30, 30]
+        @test plant.sizes[1].variable_operating_cost == [30, 30]
+        @test plant.sizes[2].capacity == 1000
+        @test plant.sizes[2].opening_cost == [1250, 1250]
+        @test plant.sizes[2].fixed_operating_cost == [30, 30]
+        @test plant.sizes[2].variable_operating_cost == [30, 30]
+
+        p1 = product_name_to_product["P1"]
+        @test p1.disposal_limit == [1.0, 1.0]
+        @test p1.disposal_cost == [-1000.0, -1000.0]
+        @test p1.acquisition_cost == [0.5, 0.5]
+
+        p2 = product_name_to_product["P2"]
+        @test p2.disposal_limit == [0.0, 0.0]
+        @test p2.disposal_cost == [0.0, 0.0]
+        @test p2.acquisition_cost == [0.0, 0.0]
+
+        p3 = product_name_to_product["P3"]
+        @test length(plant.output) == 2
+        @test plant.output[p2] == 0.2
+        @test plant.output[p3] == 0.5
+        @test plant.disposal_limit[p2] == [1, 1]
+        @test plant.disposal_limit[p3] == [1, 1]
+        @test plant.disposal_cost[p2] == [-10, -10]
+        @test plant.disposal_cost[p3] == [-10, -10]
+
+        plant = location_name_to_plant["L3"]
+        @test plant.location_name == "L3"
+        @test plant.input.name == "P2"
+        @test plant.latitude == 25
+        @test plant.longitude == 65
+        @test plant.initial_capacity == 0
+
+        @test length(plant.sizes) == 2
+        @test plant.sizes[1].capacity == 1000.0
+        @test plant.sizes[1].opening_cost == [3000, 3000]
+        @test plant.sizes[1].fixed_operating_cost == [50, 50]
+        @test plant.sizes[1].variable_operating_cost == [50, 50]
+        @test plant.sizes[1] == plant.sizes[2]
+
+        p4 = product_name_to_product["P4"]
+        @test plant.output[p3] == 0.05
+        @test plant.output[p4] == 0.8
+        @test plant.disposal_limit[p3] == [1e8, 1e8]
+        @test plant.disposal_limit[p4] == [0, 0]
+    end
+
+    @testset "parse (geodb)" begin
+        instance = RELOG.parsefile(fixture("s2.json"))
+        centers = instance.collection_centers
+        @test centers[1].name == "C1"
+        @test centers[1].latitude == 41.83956
+        @test centers[1].longitude == -88.08857
+    end
+end

test/src/model/build_test.jl

@@ -0,0 +1,46 @@
+# Copyright (C) 2020 Argonne National Laboratory
+# Written by Alinson Santos Xavier <axavier@anl.gov>
+
+using RELOG, HiGHS, JuMP, Printf, JSON, MathOptInterface.FileFormats
+
+function model_build_test()
+    @testset "build" begin
+        instance = RELOG.parsefile(fixture("s1.json"))
+        graph = RELOG.build_graph(instance)
+        model = RELOG.build_model(instance, graph, HiGHS.Optimizer)
+
+        process_node_by_location_name =
+            Dict(n.location.location_name => n for n in graph.process_nodes)
+
+        shipping_node_by_loc_and_prod_names = Dict(
+            (n.location.location_name, n.product.name) => n for
+            n in graph.plant_shipping_nodes
+        )
+
+        @test length(model[:flow]) == 76
+        @test length(model[:plant_dispose]) == 16
+        @test length(model[:open_plant]) == 12
+        @test length(model[:capacity]) == 12
+        @test length(model[:expansion]) == 18
+
+        l1 = process_node_by_location_name["L1"]
+        @test model[:is_open][l1, 0] == 1
+        @test model[:expansion][l1, 0] == 250
+
+        v = model[:capacity][l1, 1]
+        @test lower_bound(v) == 0.0
+        @test upper_bound(v) == 1000.0
+
+        v = model[:expansion][l1, 1]
+        @test lower_bound(v) == 0.0
+        @test upper_bound(v) == 750.0
+
+        v = model[:plant_dispose][shipping_node_by_loc_and_prod_names["L1", "P2"], 1]
+        @test lower_bound(v) == 0.0
+        @test upper_bound(v) == 1.0
+
+        l2 = process_node_by_location_name["L2"]
+        @test model[:is_open][l2, 0] == 0
+        @test model[:expansion][l2, 0] == 0
+    end
+end

test/src/model/resolve_test.jl

@@ -0,0 +1,13 @@
+# Copyright (C) 2020 Argonne National Laboratory
+# Written by Alinson Santos Xavier <axavier@anl.gov>
+
+using RELOG
+
+function model_resolve_test()
+    @testset "Resolve" begin
+        # Shoud not crash
+        filename = fixture("s1.json")
+        solution_old, model_old = RELOG.solve(filename, return_model = true)
+        solution_new = RELOG.resolve(model_old, filename)
+    end
+end

test/src/model/solve_test.jl

@@ -0,0 +1,70 @@
+# Copyright (C) 2020 Argonne National Laboratory
+# Written by Alinson Santos Xavier <axavier@anl.gov>
+
+using RELOG, JuMP, Printf, JSON, MathOptInterface.FileFormats
+
+
+function model_solve_test()
+    @testset "solve (exact)" begin
+        solution_filename_a = tempname()
+        solution_filename_b = tempname()
+        solution = RELOG.solve(fixture("s1.json"), output = solution_filename_a)
+
+        @test isfile(solution_filename_a)
+
+        RELOG.write(solution, solution_filename_b)
+        @test isfile(solution_filename_b)
+
+        @test "Costs" in keys(solution)
+        @test "Fixed operating (\$)" in keys(solution["Costs"])
+        @test "Transportation (\$)" in keys(solution["Costs"])
+        @test "Variable operating (\$)" in keys(solution["Costs"])
+        @test "Total (\$)" in keys(solution["Costs"])
+
+        @test "Plants" in keys(solution)
+        @test "F1" in keys(solution["Plants"])
+        @test "F2" in keys(solution["Plants"])
+        @test "F3" in keys(solution["Plants"])
+        @test "F4" in keys(solution["Plants"])
+
+        @test "Products" in keys(solution)
+        @test "P1" in keys(solution["Products"])
+        @test "C1" in keys(solution["Products"]["P1"])
+        @test "Dispose (tonne)" in keys(solution["Products"]["P1"]["C1"])
+
+        total_disposal =
+            sum([loc["Dispose (tonne)"] for loc in values(solution["Products"]["P1"])])
+        @test total_disposal == [1.0, 1.0]
+    end
+
+    @testset "solve (heuristic)" begin
+        # Should not crash
+        solution = RELOG.solve(fixture("s1.json"), heuristic = true)
+    end
+
+    @testset "solve (infeasible)" begin
+        json = JSON.parsefile(fixture("s1.json"))
+        for (location_name, location_dict) in json["products"]["P1"]["initial amounts"]
+            location_dict["amount (tonne)"] *= 1000
+        end
+        @test_throws ErrorException("No solution available") RELOG.solve(RELOG.parse(json))
+    end
+
+    @testset "solve (with storage)" begin
+        filename = fixture("storage.json")
+        instance = RELOG.parsefile(filename)
+        @test instance.plants[1].storage_limit == 50.0
+        @test instance.plants[1].storage_cost == [2.0, 1.5, 1.0]
+
+        solution = RELOG.solve(filename)
+        plant_dict = solution["Plants"]["mega plant"]["Chicago"]
+        @test plant_dict["Variable operating cost (\$)"] == [500.0, 0.0, 100.0]
+        @test plant_dict["Process (tonne)"] == [50.0, 0.0, 50.0]
+        @test plant_dict["Storage (tonne)"] == [50.0, 50.0, 0.0]
+        @test plant_dict["Storage cost (\$)"] == [100.0, 75.0, 0.0]
+
+        @test solution["Costs"]["Variable operating (\$)"] == [500.0, 0.0, 100.0]
+        @test solution["Costs"]["Storage (\$)"] == [100.0, 75.0, 0.0]
+        @test solution["Costs"]["Total (\$)"] == [600.0, 75.0, 100.0]
+    end
+end

test/src/reports_test.jl

@@ -0,0 +1,21 @@
+# RELOG: Reverse Logistics Optimization
+# Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
+# Released under the modified BSD license. See COPYING.md for more details.
+
+using RELOG, JSON, GZip
+
+function reports_test()
+    @testset "reports" begin
+        @testset "from solve" begin
+            solution = RELOG.solve(fixture("s1.json"))
+            tmp_filename = tempname()
+            # The following should not crash
+            RELOG.write_plant_emissions_report(solution, tmp_filename)
+            RELOG.write_plant_outputs_report(solution, tmp_filename)
+            RELOG.write_plants_report(solution, tmp_filename)
+            RELOG.write_products_report(solution, tmp_filename)
+            RELOG.write_transportation_emissions_report(solution, tmp_filename)
+            RELOG.write_transportation_report(solution, tmp_filename)
+        end
+    end
+end