Building Neuroptikon - JaneliaSciComp/Neuroptikon GitHub Wiki

If you simply want to use Neuroptikon, download one of the installers. If you want to create a new installer, you are in the right place.

To test locally, you need to have certain python modules installed:

• wxpython
  • [on Windows] Install wxpython from http://wxpython.org/download.php#msw
  • [on Mac and Linux] sudo easy_install wxpython

To build on Mac, install the following prerequisites:

• export CFLAGS="-arch i386 -arch x86_64"
• pcre http://www.pcre.org/ (make sure to not accidentally download pcre2)
• swig http://sourceforge.net/projects/swig/
• OpenSceneGraph http://www.openscenegraph.org/
• osgswig https://github.com/cmbruns/osgswig
• python 2.7 https://www.python.org/downloads/

On Windows

• Install Qt from * On Windows install Qt from http://download.qt.io/archive/qt/4.7/qt-win-opensource-4.7.4-vs2008.exe (or build yourself in 32-bit with Visual Studio 2010, for better match with Python)

• Test current code base in place

  • make sure you do not have alternate version of OSG and Qt libraries on your PATH
  • cd Source
  • python neuroptikon.py

• Edit version number in Source/_version_.py

• (WINDOWS Only) Edit version number in Source/Neuroptikon.iss

• To create installer on Windows (from comments in setup.py):

  • Complete initial setup of development environment, if not already done:
    • Edit Source line in Source/Neuroptikon.iss to point to local source folder
    • Install latest Python 2.7 from python.org
    • Install Inno Setup QuickStart Pack from http://jrsoftware.org/isdl.php
      • Be sure to install the "preprocessor" along with the compiler
  • Commit current code state
  • python setup.py --quiet py2exe

• To create installer on Mac (based on comments in setup.py)

  • Complete initial setup of development environment, if not already done:
    • Make sure the python from python.org is your active python version
    • sudo easy_install py2app
    • sudo easy_install numpy
    • sudo easy_install sphinx
    • sudo easy_install wxpython
    • copy osgswig files _osg*.so and osg*.py to Source/lib/Darwin/ folder
  • python setup.py --quiet py2app
  • If "hdiutil" command fails, try opening the build/.../Neuroptikon.app bundle from Finder, then rerun setup.py

• Finally:

  • run and test resulting installer
  • create release at github
    • create new git tag
    • create new release based on that tag
    • drag installer(s) onto release

• Commit and test all changes locally.

• Build installer (above)

• Create git tag at current revision like "Release1.0.0rc8"

  git tag "Release"

• Push changes to github, including tags

  git push origin --tags

• On the github Neuroptikon web site, click "releases"->"Draft a new release"

• In the "Tag version" field, select that tag you just recently pushed. It should be available as an option.

• Fill out the title, and write some release notes in the big text area.

• Drag your binary installers onto the designated area.

• Click "Publish release"