diff --git a/Project.toml b/Project.toml index 2cec1cc..2306b59 100644 --- a/Project.toml +++ b/Project.toml @@ -1,4 +1,4 @@ -name = "ReverseManufacturing" +name = "RELOG" uuid = "a2afcdf7-cf04-4913-85f9-c0d81ddf2008" authors = ["Alinson S Xavier "] version = "1.0.0" diff --git a/README.md b/README.md index 6cc50c5..7fefcec 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -ReverseManufacturing.jl -======================= +RELOG: Reverse Logistics Optimization +===================================== -**ReverseManufacturing.jl** is an optimization package for logistic decisions related to reverse manufacturing processes. 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 manufacturing pipelines, with multiple types of plants, multiple types of product and multiple time periods. +**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. Table of Contents ================= @@ -18,13 +18,13 @@ Installation The package was developed and tested with Julia 1.3 and may not be compatible with newer versions. To install it, launch the Julia console, type `]` to switch to package manager mode and run: ``` -pkg> add git@github.com:iSoron/ReverseManufacturing.git +pkg> add git@github.com:iSoron/RELOG.git ``` To make sure that the package has been correctly installed: ``` -pkg> test ReverseManufacturing +pkg> test RELOG ``` Typical Usage @@ -32,7 +32,7 @@ Typical Usage ### Describing an instance -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/s1.json`. +The first step when using RELOG 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/s1.json`. ### Parameters @@ -95,8 +95,8 @@ The keys in the disposal dictionary should be the names of the products. The val After creating a JSON file describing the reverse manufacturing process and the input data, the following example illustrates how to use the package to find the optimal set of decisions: ```julia -using ReverseManufacturing -ReverseManufacturing.solve("/home/user/instance.json") +using RELOG +RELOG.solve("/home/user/instance.json") ``` The optimal logistics plan will be printed to the screen. diff --git a/src/ReverseManufacturing.jl b/src/RELOG.jl similarity index 100% rename from src/ReverseManufacturing.jl rename to src/RELOG.jl diff --git a/test/graph_test.jl b/test/graph_test.jl index 4699a46..3a8802b 100644 --- a/test/graph_test.jl +++ b/test/graph_test.jl @@ -1,13 +1,13 @@ # Copyright (C) 2020 Argonne National Laboratory # Written by Alinson Santos Xavier -using ReverseManufacturing +using RELOG @testset "Graph" begin @testset "build_graph" begin basedir = dirname(@__FILE__) - instance = ReverseManufacturing.load("$basedir/../instances/s1.json") - graph = ReverseManufacturing.build_graph(instance) + instance = RELOG.load("$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) diff --git a/test/instance_test.jl b/test/instance_test.jl index 9582fe8..5865ad2 100644 --- a/test/instance_test.jl +++ b/test/instance_test.jl @@ -1,12 +1,12 @@ # Copyright (C) 2020 Argonne National Laboratory # Written by Alinson Santos Xavier -using ReverseManufacturing +using RELOG @testset "Instance" begin @testset "load" begin basedir = dirname(@__FILE__) - instance = ReverseManufacturing.load("$basedir/../instances/s1.json") + instance = RELOG.load("$basedir/../instances/s1.json") centers = instance.collection_centers plants = instance.plants diff --git a/test/model_test.jl b/test/model_test.jl index 4f70c0e..fdb3558 100644 --- a/test/model_test.jl +++ b/test/model_test.jl @@ -1,14 +1,14 @@ # Copyright (C) 2020 Argonne National Laboratory # Written by Alinson Santos Xavier -using ReverseManufacturing, Cbc, JuMP, Printf, JSON, MathOptInterface.FileFormats +using RELOG, Cbc, JuMP, Printf, JSON, MathOptInterface.FileFormats @testset "Model" begin @testset "build" begin basedir = dirname(@__FILE__) - instance = ReverseManufacturing.load("$basedir/../instances/s1.json") - graph = ReverseManufacturing.build_graph(instance) - model = ReverseManufacturing.build_model(instance, graph, Cbc.Optimizer) + instance = RELOG.load("$basedir/../instances/s1.json") + graph = RELOG.build_graph(instance) + model = RELOG.build_model(instance, graph, Cbc.Optimizer) process_node_by_location_name = Dict(n.location.location_name => n for n in graph.process_nodes) @@ -43,7 +43,7 @@ using ReverseManufacturing, Cbc, JuMP, Printf, JSON, MathOptInterface.FileFormat end @testset "solve" begin - solution = ReverseManufacturing.solve("$(pwd())/../instances/s1.json") + solution = RELOG.solve("$(pwd())/../instances/s1.json") JSON.print(stdout, solution, 4) @test "costs" in keys(solution) diff --git a/test/runtests.jl b/test/runtests.jl index 4bb8cf1..5c2ad21 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -3,7 +3,7 @@ using Test -@testset "ReverseManufacturing" begin +@testset "RELOG" begin include("instance_test.jl") include("graph_test.jl") include("model_test.jl")