Shape-Out runs on Python 2 only. One reason are dependency issues (chaco and Anaconda on Windows). The other reason is that the development of Shape-Out 2 has higher priority than migrating Shape-Out 1 to Python 3. The easiest way to run Shape-Out from source is to use Anaconda.
- Windows:
Sketchy installation instructions can be found here.
Debian/Ubuntu: Install all dependencies from the distribution repositories:
sudo apt install cython python2.7-dev python-chaco python-numpy python-scipy python-wxgtk3.0 r-base r-recommended r-cran-lme4 virtualenv
Checkout the fcswrite and dclab repositories and install them in editable mode with
cd path/to/dclab pip install -e . cd path/to/fcswrite pip install -e .
Install other dependencies for ShapeOut and chaco:
pip install simplejson kiwisolver reportlab
Checkout the Shape-Out repository and install in editable mode:
cd path/to/ShapeOut pip install -e .[GUI]
Download the ffmpeg binaries (required for tdms file format):
travis_retry imageio_download_bin ffmpeg
Start ShapeOut with:
python -m shapeout
MacOS: Shape-Out should work with Anaconda (see Windows above). It is also possible to install all dependencies with MacPorts:
sudo port install python27 py27-ipython py27-scipy py27-matplotlib sudo port install opencv +python27 sudo port install py27-wxpython-3.0 py27-kiwisolver py27-chaco py27-pip py27-simplejson py27-sip py27-macholib sudo pip-2.7 install nptdms sudo pip-2.7 install pyper
Then select python27 (macports) as standard python interpreter:
sudo port select --set python python27 sudo port select --set pip pip27
Checkout the fcswrite and dclab repositories and install them in editable mode with
cd path/to/dclab pip install -e . cd path/to/fcswrite pip install -e .
Install other dependencies for ShapeOut and chaco:
pip install simplejson kiwisolver reportlab
Checkout the Shape-Out repository and install in editable mode:
cd path/to/ShapeOut pip install -e .[GUI]
Download the ffmpeg binaries (required for tdms file format):
travis_retry imageio_download_bin ffmpeg
Start ShapeOut with:
python -m shapeout
The main branch for developing Shape-Out is develop. Small changes that do not
break anything can be submitted to this branch.
If you want to do big changes, please (fork Shape-Out and) create a separate branch,
e.g. my_new_feature_dev, and create a pull-request to develop once you are done making
your changes.
Please make sure to edit the
Changelog.
Very important: Please always try to use
git pull --rebase
instead of
git pull
to prevent confusions in the commit history.
Shape-Out is tested using pytest. If you have the time, please write test
methods for your code and put them in the tests directory. You may
run the tests manually by issuing:
python setup.py test
After each commit to the Shape-Out repository, a binary installer is created
by Appveyor. Click
on a build and navigate to ARTIFACTS (upper right corner right under
the running time of the build). From there you can download the executable
Windows installer.
Please do not create releases when you want to test if something you did works in the final Windows binary. Use the method described above to do so. Releases should be created when improvements were made, bugs were resolved, or new features were introduced.
Make sure that the changelog (develop) is updated.
Create a pull request from develop into master using the web interface or simply run
git checkout master git pull origin develop git push
Create the release at https://github.com/ZELLMECHANIK-DRESDEN/ShapeOut/releases. Make sure that the tag of the release follows the version format of Shape-Out (e.g. 0.5.3) and also name the release correctly (e.g. Shape-Out 0.5.3). Also, copy and paste the changelog of the new version into the comments of the release. The first line of the release comments should contain the download counts shield like so:
The rest should contain the changelog. Make sure to check This is a pre-release box.
Once the release is created, Appveyor will perform the build process and upload the installation files directly to the release. If the binary works, edit the release and uncheck the This is a pre-release box.
Make sure that all the changes you might have performed on the master branch are brought back to
develop.git checkout develop git pull origin master git pull --tags origin master git push