The first step when using ReverseManufacturing.jl is describing the reverse manufacturing pipeline and the relevant data. Each input file is a JSON file with two sections: `products` and `plants`. Below, we describe each section in more detail. For a concrete example, see the file `instances/samples/s2.json`.
The first step when using ReverseManufacturing.jl is describing the reverse manufacturing pipeline and the relevant data. Each input file is a JSON file with three sections: `parameters`, `products` and `plants`. Below, we describe each section in more detail. For a concrete example, see the file `instances/samples/s2.json`.
### Parameters
The **parameters** section describes details about the simulation itself.
| Key | Description
|:------------------------|---------------|
|`time periods` | Number of time periods in the simulation.
#### Products
#### 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:
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:
* `transportation cost`, the cost (in dollars per km per kg) to transport this product.
| Key | Description
* `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.
|:------------------------|---------------|
|`transportation cost` | The cost (in dollars per km per tonnes) to transport this product. Must be a timeseries.
|`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 timeseries.
Each product may have some amount available at the beginning of the simulation. In this case, the key `initial amounts` maps to a dictionary with the following keys:
Each product may have some amount available at the beginning of the simulation. In this case, the key `initial amounts` maps to a dictionary with the following keys:
* `latitude`, the latitude of the location, in degrees.
| Key | Description
* `longitude`, the longitude of the location, in degrees.
|:------------------------|---------------|
* `amount`, the amount (in kg) of the product initially available at the location.
| `latitude` | The latitude of the location, in degrees.
| `longitude` | The longitude of the location, in degrees.
| `amount` | The amount (in tonnes) of the product initially available at the location. Must be a timeseries.
#### Processing Plants
#### 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:
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:
* `input`, the name of the product that this plant takes as input. Only one input is accepted per plant.
| Key | Description
* `outputs`, a dictionary specifying how many kg of each product is produced for each kg of input. For example, if the plant outputs 0.5 kg of P2 and 0.25 kg of P3 for each kg 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.
|:------------------------|---------------|
* `locations`, a dictionary mapping the name of the location to a dictionary which describes the site characteristics (see below).
| `input` | The name of the product that this plant takes as input. Only one input is accepted per plant.
| `outputs` | 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.
| `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:
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:
* `latitude`, the latitude of the location, in degrees.
| Key | Description
* `longitude`, the longitude of the location, in degrees.
|:------------------------|---------------|
* `opening cost`, the cost (in dollars) to open the plant.
| `latitude` | The latitude of the location, in degrees.
* `fixed operating cost`, the cost (in dollars) to keep the plant open, even if the plant doesn't process anything.
| `longitude` | The longitude of the location, in degrees.
* `variable operating cost`, the cost (in dollars per kg) that the plant incurs to process each kg of input.
| `opening cost` | The cost (in dollars) to open the plant.
* `base capacity`, the amount of input (in kg) the plant can process when zero dollars are spent on expansion. If unlimited, this key may be omitted.
| `fixed operating cost` | The cost (in dollars) to keep the plant open, even if the plant doesn't process anything. Must be a timeseries.
* `max capacity`, the amount (in kg) the plant can process when the maximum amount of dollars are spent on expansion. If unlimited, this key may be omitted.
| `variable operating cost` | The cost (in dollars per tonnes) that the plant incurs to process each tonnes of input. Must be a timeseries.
* `expansion cost`, the cost (in dollars per kg) to increase the plant capacity beyond its base capacity. If zero, this key may be omitted.
| `base capacity` | The amount of input (in tonnes) the plant can process when zero dollars are spent on expansion. If unlimited, this key may be omitted.
* `disposal`, a dictionary describing what products can be disposed locally at the plant.
| `max capacity` | The amount (in tonnes) the plant can process when the maximum amount of dollars are spent on expansion. If unlimited, this key may be omitted.
| `expansion cost` | The cost (in dollars per tonnes) to increase the plant capacity beyond its base capacity. If zero, this key may be omitted. Must be a timeseries.
| `disposal` | A dictionary describing what products can be disposed locally at the plant.
The keys in the disposal dictionary should be the names of the products. The values are dictionaries with the following keys:
The keys in the disposal dictionary should be the names of the products. The values are dictionaries with the following keys:
* `cost`, the cost (in dollars per kg) to dispose of the product.
| Key | Description
* `limit`, the maximum amount (in kg) that can be disposed of. If an unlimited amount can be disposed, this key may be omitted.
|:------------------------|---------------|
| `cost` | The cost (in dollars per tonnes) to dispose of the product. Must be a timeseries.
| `limit` | The maximum amount (in tonnes) that can be disposed of. If an unlimited amount can be disposed, this key may be omitted. Must be a timeseries.
The optimal logistics plan will be printed to the screen.
The optimal logistics plan will be printed to the screen.
Current Limitations
Model Assumptions
-------------------
-----------------
* Each plant is only allowed exactly one product as input
* Each plant can only be opened exactly once. After open, the plant remains open until the end of the simulation.
* No support for multi-period simulations
* Plants can be expanded at any time, even long after they are open.
* Variable and fixed operating costs do not change according to plant size.
* 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.
