From 44008c349d71cb0c9688e5a654693d76ee215b46 Mon Sep 17 00:00:00 2001 From: "Alinson S. Xavier" Date: Thu, 23 Feb 2023 11:19:07 -0600 Subject: [PATCH] Bump package version --- Makefile | 3 +-- Project.toml | 2 +- README.md | 22 ++++++++++------------ docs/src/index.md | 16 +++++++++------- docs/src/usage.md | 22 ++++++++++------------ 5 files changed, 31 insertions(+), 34 deletions(-) diff --git a/Makefile b/Makefile index 0239ef3..4d0f4ba 100644 --- a/Makefile +++ b/Makefile @@ -1,11 +1,10 @@ -VERSION := 0.6 +VERSION := 0.7 PKG := ghcr.io/anl-ceeesa/relog-web clean: rm -rfv build Manifest.toml test/Manifest.toml deps/formatter/build deps/formatter/Manifest.toml docs: - cd docs; julia --project=. make.jl; cd .. rsync -avP --delete-after docs/build/ ../docs/$(VERSION)/ docker-build: diff --git a/Project.toml b/Project.toml index 5364c1d..42a71e4 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "RELOG" uuid = "a2afcdf7-cf04-4913-85f9-c0d81ddf2008" authors = ["Alinson S Xavier "] -version = "0.6.0" +version = "0.7.0" [deps] CRC = "44b605c4-b955-5f2b-9b6d-d2bd01d3d205" diff --git a/README.md b/README.md index a581688..f913480 100644 --- a/README.md +++ b/README.md @@ -13,24 +13,22 @@ **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. - - - + ### Documentation - * [Usage](https://anl-ceeesa.github.io/RELOG/0.6/usage) - * [Input and Output Data Formats](https://anl-ceeesa.github.io/RELOG/0.6/format) - * [Simplified Solution Reports](https://anl-ceeesa.github.io/RELOG/0.6/reports) - * [Optimization Model](https://anl-ceeesa.github.io/RELOG/0.6/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 -* **Alinson S. Xavier** <> -* **Nwike Iloeje** <> -* **John Atkins** -* **Kyle Sun** -* **Audrey Gallier** +- **Alinson S. Xavier** <> +- **Nwike Iloeje** <> +- **John Atkins** +- **Kyle Sun** +- **Audrey Gallier** ### License diff --git a/docs/src/index.md b/docs/src/index.md index bb485e3..2b35dc6 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -8,22 +8,24 @@ ``` - ### Table of Contents - ```@contents +```@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 -* **Nwike Iloeje,** Argonne National Laboratory + +- **Alinson S. Xavier,** Argonne National Laboratory +- **Nwike Iloeje,** Argonne National Laboratory +- **John Atkins** +- **Kyle Sun** +- **Audrey Gallier** ### License @@ -52,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. -``` \ No newline at end of file +``` diff --git a/docs/src/usage.md b/docs/src/usage.md index 19cea94..14843ae 100644 --- a/docs/src/usage.md +++ b/docs/src/usage.md @@ -1,5 +1,4 @@ -Usage -===== +# Usage ## 1. Installation @@ -7,7 +6,7 @@ To use RELOG, the first step is to install the [Julia programming language](http ```julia using Pkg -Pkg.add(name="RELOG", version="0.6") +Pkg.add(name="RELOG", version="0.7") ``` ## 2. Modeling the problem @@ -16,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). @@ -90,7 +89,6 @@ 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