Metadata-Version: 2.1
Name: openclsim
Version: 0.3.0
Summary: The OpenCLSim package aims to facilitate rule based planning of cyclic activities and in depth comparison of different system concepts.
Home-page: https://github.com/TUDelft-CITG/openclsim
Author: Mark van Koningsveld
Author-email: m.vankoningsveld@tudelft.nl
License: mit
Keywords: OpenCLSim
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: simpy
Requires-Dist: networkx
Requires-Dist: halem
Requires-Dist: shapely
Requires-Dist: scipy
Requires-Dist: click
Requires-Dist: matplotlib
Requires-Dist: pint
Requires-Dist: pyproj
Requires-Dist: plotly
Requires-Dist: simplekml
Requires-Dist: nose
Requires-Dist: Flask
Requires-Dist: Flask-cors
Requires-Dist: Dill (>=0.2.8)
Requires-Dist: sphinx-rtd-theme
Provides-Extra: testing
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: pytest-timeout ; extra == 'testing'

[![CircleCI](https://circleci.com/gh/TUDelft-CITG/OpenCLSim.svg?style=svg&circle-token=fc95d870dc21fdf11e1ebc02f9defcd99212197a)](https://circleci.com/gh/TUDelft-CITG/OpenCLSim)

[![Coverage](https://oedm.vanoord.com/proxy/circleci_no_redirect/github/TUDelft-CITG/OpenCLSim/master/latest/3b00333d4fe20c813bd9bc81ce2e1d4f5fae987a/tmp/artifacts/coverage.svg)](https://oedm.vanoord.com/proxy/circleci_no_redirect/github/TUDelft-CITG/OpenCLSim/master/latest/3b00333d4fe20c813bd9bc81ce2e1d4f5fae987a/tmp/artifacts/index.html)
[ ![Documentation](https://img.shields.io/badge/sphinx-documentation-brightgreen.svg)](https://openclsim.readthedocs.io)
[ ![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://github.com/TUDelft-CITG/OpenCLSim/blob/master/LICENSE.txt)

# OpenCLSim

Complex Logistics Simulation - Rule based planning of cyclic activities for in-depth comparison of different system concepts.

Documentation can be found [here](https://oedm.vanoord.com/proxy/circleci_no_redirect/github/TUDelft-CITG/OpenCLSim/master/latest/3b00333d4fe20c813bd9bc81ce2e1d4f5fae987a/tmp/artifacts/docs/index.html).

## Installation

To install OpenCLSim, run this command in your terminal:

``` bash
pip install openclsim
```

This is the preferred method to install OpenCLSim, as it will always install the most recent stable release.

If you donâ€™t have [pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.

You can read the [documentation](https://oedm.vanoord.com/proxy/circleci_no_redirect/github/TUDelft-CITG/OpenCLSim/master/latest/3b00333d4fe20c813bd9bc81ce2e1d4f5fae987a/tmp/artifacts/docs/installation.html) for other installation methods.

## Example notebooks

The benefit of OpenCLSim is the generic set-up. This set-up allows the creation of complex logistical flows. A number of examples are presented in the [notebooks folder](https://github.com/TUDelft-CITG/OpenCLSim/tree/master/notebooks). You can run them locally or as an [Azure notebook](https://notebooks.azure.com/joris-denuijl/projects/openclsim/tree/notebooks).

## Start server

A flask server is part of the OpenCLSim package. The example code below lets you start the Flask server from the windows command line, for other operation systems please check the [Flask Documentation](http://flask.pocoo.org/docs/dev/cli/).

``` bash
# Set Flask app
set FLASK_APP=openclsim/server.py

# Set Flask environment
set FLASK_ENV=development

# Run Flask
flask run
```


