Installation and Getting Started

If you are familiar with Python and installing python libraries, feel free to skip below to the installation section.

opcsim requires python3.5+ to be installed on your computer. If you do not have an existing installation, I would recommend checking out the Anaconda Python distribution. If you encounter issues installing Anaconda, check out StackOverflow or a simple Google search.

Once you have python installed, you can go ahead and install the opcsim python library.

Dependencies

• Python3.5+

• numpy

• scipy

• pandas

• matplotlib

• seaborn

Installing opcsim

There are several ways to install the package from source depending on your local development environment and familiarity with installing python libraries. If you are new to python (and don’t have git installed), install using the Install from Source option.

Install directly from pypi (best option)

Installing directly from pypi using pip is the easiest way forward and will automagically install any dependencies that aren’t already installed.

$ pip install opcsim [--upgrade]

Install from GitHub using pip

Note: must have git installed

$ pip install --upgrade git+git://github.com/dhhagan/opcsim.git

Clone Repository and Install from GitHub

If you plan on contributing to opcsim, you will probably want to fork the library, and then clone it to your local environment. You can then install from source directly.

$ git clone https://github.com/dhhagan/opcsim.git
$ cd opcsim/
$ python3 setup.py install

Install from Source

$ wget https://github.com/dhhagan/opcsim/archive/master.zip
$ unzip master.zip
$ cd opcsim-master/
$ python3 setup.py install

Testing

Testing is automated using unittests. To run the unittests with coverage reporting, run the following commands from the main directory:

$ coverage run --source opcsim setup.py test
$ coverage report -m

Unittests are also run automatically through continuous integration via TravisCI upon every pull request and code coverage is tracked online with Code Climate.

Reporting Bugs and other Issues

Please report any bugs or issues you find through the GitHub issues tracker. Please provide as much information as possible that will make it easier to solve/fix the problem. Useful information to include would be the operating system, python version, and version of the opcsim library as well as any dependencies. If there are issues with graphics, screenshots are very helpful!