Supply Chain Optimization Package
Project description
SC Optimize
Supply Chain Optimization package in python using PuLP.
Setup
Make sure you have Python 3.6.x (or higher) installed on your system. You can download it here.
Installation
pip install scoptimize
Getting Started
Technical Documentation
The Technical Docs can be found here.
Basic Usage
from scoptimize.network import Model, Node, Flow
model = Model(name='MyModel')
model.add_object(Node(name="Factory_1", origin=True, cashflow_per_unit=-1, max_units=15))
model.add_object(Node(name="Customer_1", destination=True, min_units=10))
model.add_object(Flow(name="Factory_1__Customer_1", cashflow_per_unit=-1, max_units=15, start='Factory_1', end='Customer_1'))
model.solve()
print(model.objective) #=> 20.0
Advanced Usage
Input:
from scoptimize.network import Model, Node, Flow
from pprint import pp
model = Model(name='MyAdvancedModel')
model.add_object(Node(name="F1", origin=True, cashflow_for_use=-8, cashflow_per_unit=-1, max_units=5))
model.add_object(Node(name="F2", origin=True, cashflow_per_unit=-2, max_units=10))
model.add_object(Node(name="W1", cashflow_per_unit=-1, max_units=10))
model.add_object(Node(name="D1", destination=True, cashflow_per_unit=0, min_units=8, max_units=10))
model.add_object(Flow(name="F1_W1", cashflow_per_unit=-1, max_units=15, start='F1', end='W1'))
model.add_object(Flow(name="F2_W1", cashflow_per_unit=-1, max_units=15, start='F2', end='W1'))
model.add_object(Flow(name="W1_D1", cashflow_per_unit=-1, max_units=15, start='W1', end='D1'))
model.solve()
pp(model.get_object_stats())
Output:
{'F1': {'name': 'F1',
'class': 'Node',
'origin': True,
'destination': False,
'inflows': 0.0,
'outflows': 0.0,
'reflows_in': 0.0,
'reflows_out': 0.0,
'use': 0.0,
'variable_cashflow': -0.0,
'fixed_cashflow': -0.0},
'F2': {'name': 'F2',
'class': 'Node',
'origin': True,
'destination': False,
'inflows': 0.0,
'outflows': 8.0,
'reflows_in': 0.0,
'reflows_out': 0.0,
'use': 1.0,
'variable_cashflow': -16.0,
'fixed_cashflow': 0.0},
'W1': {'name': 'W1',
'class': 'Node',
'origin': False,
'destination': False,
'inflows': 8.0,
'outflows': 8.0,
'reflows_in': 0.0,
'reflows_out': 0.0,
'use': 1.0,
'variable_cashflow': -8.0,
'fixed_cashflow': 0.0},
'D1': {'name': 'D1',
'class': 'Node',
'origin': False,
'destination': True,
'inflows': 8.0,
'outflows': 0,
'reflows_in': 0.0,
'reflows_out': 0.0,
'use': 1.0,
'variable_cashflow': 0.0,
'fixed_cashflow': 0.0},
'F1_W1': {'name': 'F1_W1',
'class': 'Flow',
'reflow': False,
'start': 'F1',
'end': 'W1',
'flow': 0.0,
'use': 1.0,
'variable_cashflow': -0.0,
'fixed_cashflow': 0.0},
'F2_W1': {'name': 'F2_W1',
'class': 'Flow',
'reflow': False,
'start': 'F2',
'end': 'W1',
'flow': 8.0,
'use': 1.0,
'variable_cashflow': -8.0,
'fixed_cashflow': 0.0},
'W1_D1': {'name': 'W1_D1',
'class': 'Flow',
'reflow': False,
'start': 'W1',
'end': 'D1',
'flow': 8.0,
'use': 1.0,
'variable_cashflow': -8.0,
'fixed_cashflow': 0.0}}
Testing
Docker:
docker build . --tag scoptimize_docker_test
docker run scoptimize_docker_test bash ./test.sh
Local:
python3.11 -m virtualenv venv
source venv/bin/activate
pip install -e .
./test.sh
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
scoptimize-1.0.1.tar.gz
(8.3 kB
view details)
Built Distribution
File details
Details for the file scoptimize-1.0.1.tar.gz
.
File metadata
- Download URL: scoptimize-1.0.1.tar.gz
- Upload date:
- Size: 8.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbf6fb2b79723377d8c42a21be87daa840a0b62b9e7be89f9f64b6b15c722591 |
|
MD5 | d5519f433a1314f177d8ca8eaf683c89 |
|
BLAKE2b-256 | fa420601683c67bc59bea5db7d54eb925456f364f488d4ca51b8be11b46a2994 |
File details
Details for the file scoptimize-1.0.1-py3-none-any.whl
.
File metadata
- Download URL: scoptimize-1.0.1-py3-none-any.whl
- Upload date:
- Size: 7.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbafda14c414596d9f5cc5794e2c841dee9cd5d3388a622e22242a6e8de6a56e |
|
MD5 | 8591676c9399b302047d52aa6114879e |
|
BLAKE2b-256 | 814dab849075a35d3fe569a48362590e2d40d5ecf08814c5e3c853c3dba651ce |