Skip to content

Prepare your environment for development of simex_platform (python lib)

Carsten Fortmann-Grote edited this page Apr 13, 2018 · 4 revisions

Follow these instructions before starting to develop in the python library part of simex_platform

Get a github account

Fork the simex_platform repository

While logged in on github, click the "Fork" button on the top right of eucall-software/simex_platform.

Clone your forked repository:

In your $HOME, do

$> git clone [email protected]:<your_github_username>/simex_platform

Check out the python3 branch:

$> cd simex_platform

$> git checkout python3

DO NOT CONFIGURE/BUILD/INSTALL!!!!!

Activate the simex environment:

$> module load simex

Modify your PYTHONPATH to load the SimEx library from your development repository

$> export PYTHONPATH=$HOME/simex_platform/Sources/python:$PYTHONPATH

Check that it works:

$> python -c "import SimEx; print(SimEx.__file__)"

should return something like

/home/<your_user_name>/simex_platform/Sources/python/SimEx/__init__.py

Run the test suite (and redirect errors and log messages to stdout AND a log file).

Attention: The test suite takes ~20 minutes to complete. You can also run individual test suites or even individual test methods.

$> cd Tests/python/unittest

$> python Test.py -v 2>&1 | tee log

Now you can ...

make changes, add new stuff, commit, push to your remote repo and make pull requests to eucall-software/simex_platform. Ideally, you would run the test suite before pushing anything and only push if the tests passed.