Quick start guide

This manual will show users how to install WORC, configure WORC and construct and run simple networks.

Installation

You can install WORC either using pip, or from the source code.

Installing via pip

You can simply install WORC using pip:

pip install WORC

Note

You might want to consider installing WORC in a virtualenv

Installing from source code

To install from source code, use git via the command-line:

git clone https://github.com/MStarmans91/WORC.git  # for http
git clone ssh://git@github.com:MStarmans91/WORC.git # for ssh

To install to your current Python environment, run:

cd WORC/
pip install .

This installs the scripts and packages in the default system folders. For Windows this is the python site-packages directory for the WORC python library. For Ubuntu this is in the /usr/local/lib/python3.x/dist-packages/ folder.

Note

If you want to develop WORC, you might want to use pip install -e . to get an editable install

Note

You might want to consider installing WORC in a virtualenv

Configuration

WORC has defaults for all settings so it can be run out of the box to test the examples. However, you may want to alter the fastr configuration to your system settings, e.g. to locate your input and output folders and how much you want to parallelize the execution.

Fastr will search for a config file named config.py in the $FASTRHOME directory (which defaults to ~/.fastr/ if it is not set). So if $FASTRHOME is set the ~/.fastr/ will be ignored. Additionally, .py files from the $FASTRHOME/config.d folder will be parsed as well. You will see that upon installation, WORC has already put a WORC_config.py file in the config.d folder.

For a sample configuration file and a complete overview of the options in config.py see the Config file section.

Tutorial

To start out using WORC, we recommend you to follow the tutorial located in the [WORCTutorial Github](https://github.com/MStarmans91/WORCTutorial). Besides some more advanced tutorials, the main tutorial can be found in the WORCTutorial.ipynb Jupyter notebook. Instructions on how to use the notebook can be found in the Github.

If you run into any issue, you can first debug your network using the fastr trace tool. If you’re stuck, feel free to post an issue on the WORC Github.