Contents

  1. Binary Distribution
    1. Jenkins Setup
      1. Jenkins Server Setup (on Linux)
  2. Anaconda
    1. Conda
    2. Recipes, Feedstocks and anaconda.org channel: cryoem
    3. Feedstocks
      1. General instructions
      2. Conda-smithy Workflow
  3. Build System Notes
    1. CMake

Binary Distribution

Jenkins Setup

Jenkins server runs on Linux, Jenkins agents on Linux, Mac and Windows. The server instance manages Jenkins, the agents run the jobs.

  1. On Linux, to start Jenkins, run command:

    docker stop jenkins-master

docker rm jenkins-master

docker run -d -u root --name jenkins-master -p 8080:8080 -p 50000:50000 --restart unless-stopped -v /home/eman2/jenkins_home:/var/jenkins_home -e PLUGINS_FORCE_UPGRADE=true -e TRY_UPGRADE_IF_NO_MARKER=true --restart unless-stopped jenkins/jenkins:lts
  2. Server login info: 10.10.11.176:8080/ username: eman2
  3. Install Java on agents.
  4. Setup passwordless ssh connections from Linux server to agents.

  5. Binary builds require conda-build and constructor. Packaging is done with constructor, a tool for making installers from conda packages.

  6. Nodes: http://10.10.11.176:8080/computer/

    1. http://10.10.11.176:8080/computer/linux/configure

      1. name: linux
      2. remoteFS: /home/eman2/linux-1-agent/
      3. numExecutors: 100
      4. host: eman-centos7-01
      5. credentialsId: jenkins-key-eman2
      6. label: eman
      7. envVars
        1. DEPLOY_PATH: /opt/web2py_apps/web2py/applications/cryoem/static/software/
        2. HOME_DIR: /home/eman2
        3. PATH+EXTRA: /home/eman2/miniconda3/bin

    2. http://10.10.11.176:8080/computer/mac/configure

      1. name: mac
      2. remoteFS: /Users/eman/mac-1-agent
      3. numExecutors: 100
      4. host: eman-macmini
      5. credentialsId: jenkins-key-eman
      6. label: eman
      7. envVars
        1. DEPLOY_PATH: /opt/web2py_apps/web2py/applications/cryoem/static/software/
        2. HOME_DIR: /Users/eman/
        3. PATH+EXTRA: /Users/eman/miniconda3/bin

    3. http://10.10.11.176:8080/computer/win/configure

      1. name: win
      2. remoteFS: D:\workspace\win-1-agent
      3. numExecutors: 100
      4. host: BM-WIN-01
      5. credentialsId: jenkins-key-eman

      6. JavaPath: "D:\Downloads\openjdk-11+28_windows-x64_bin\jdk-11\bin\java.exe"

      7. Prefix Start Agent Command: "D: &&"

      8. label: eman
      9. envVars
        1. DEPLOY_PATH: /opt/web2py_apps/web2py/applications/cryoem/static/software/
        2. HOME_DIR: D:
        3. PATH+EXTRA: D:\Miniconda3;D:\Miniconda3\Scripts
      10. On Windows for sh calls in jenkins to work "Git for Windows" might need to be installed.

Jenkins Server Setup (on Linux)

  1. http://10.10.11.176:8080/manage/configure

    1. Labels: main master

    2. Jenkins URL: http://10.10.11.176:8080/

    3. System Admin e-mail address: eman-bot (linux)<eman.github@gmail.com>

    4. SSH Servers
      1. Name: Installer-Server
      2. Hostname: cryoem.bcm.edu
      3. Username: eman-binary-uploader
      4. Remote Directory: /opt/web2py_apps/web2py/applications/cryoem/static/software/

  2. http://10.10.11.176:8080/manage/configureSecurity/

    1. Agents
      1. TCP port for inbound agents
        1. Fixed: 50000
    2. Git Host Key Verification Configuration
      1. Host Key Verification Strategy
        1. Known hosts file

  3. Credentials: http://10.10.11.176:8080/manage/credentials/ 

    • ID                  Name
gh-eman-bot         eman-bot (gh-eman-
jenkins-key-eman    eman (jenkins-key-eman)
jenkins-key-eman2   eman2 (jenkins-key-eman2)
  4. Jobs

    1. http://10.10.11.176:8080/job/cryoem-eman2-trigger/: Triggers job cryoem-eman2 on agents

    2. http://10.10.11.176:8080/job/cryoem-eman2/: Test(?) and binary builds

    3. eman-dev(?): Triggers new build of eman-dev

    4. http://10.10.11.176:8080/job/eman-bump-version/

    5. http://10.10.11.176:8080/job/eman-feedstock-update-version/

    6. http://10.10.11.176:8080/job/eman-feedstock-trigger-from-eman-master/

    7. http://10.10.11.176:8080/job/build-binary/

    8. http://10.10.11.176:8080/job/build-binary-trigger/

    9. http://10.10.11.176:8080/job/eman-feedstock-building-eman-v2.99/

  5. JenkinsCI: Jenkinsfile

    1. Secrets like ssh keys are stored locally in Jenkins

    2. Manually triggered by including "[ci build]" anywhere in the last commit message. Manually triggered builds on master branch are uploaded as continuous builds and builds triggered from any other branch are uploaded to testing area.

    3. Any branch in the form of "release-" triggers continuous builds without having to include "[ci build]" in the commit message. Once the release branch is ready, release binaries are manually copied from cont. builds folder into the release folder on the server.

Anaconda

Dependencies not available on anaconda or conda-forge are available on cryoem. The binaries are built and uploaded using conda-forge's conda-smithy. conda-smithy takes care of generating feedstocks, registering them on GitHub and online CI services and building conda recipes.

  1. conda is the package manager.

  2. https://anaconda.org is the online repository of binaries.

  3. conda-build is the tool to build from source.

  4. constructor is the tool to package eman2 and dependency binaries into a single installer file.

EMAN2 is distributed as a single installer which includes all its dependencies.

Conda

Packages that are available on https://anaconda.org can be installed into any conda environment by issuing the command conda install <package>. Conda installs the package along with its dependencies. In order for packages to benefit from this automation, they need to be packaged in a specific way. That can be done with conda-build. conda-build builds packages according to instructions provided in a recipe. A recipe consists of a file with package metadata, meta.yaml, and any other necessary resources like build scripts, (build.sh, bld.bat), patches and so on.

Recipes, Feedstocks and anaconda.org channel: cryoem

Most of EMAN2 dependencies can be found on anaconda's channels, defaults and conda-forge. A few that do not exist or need to be customized have been built and uploaded to channel cryoem. The recipes are hosted in separate repositories on GitHub. Every recipe repository follows the feedstock approach of conda-forge. See here for a complete list.

Feedstocks

General instructions

  1. Existing feedstocks
  2. Files to edit: recipe/, conda-build.yaml, conda-forge.yaml
  3. conda create -n smithy conda-smithy -c conda-forge
  4. conda-smithy rerender
  5. More info in conda-smithy/README.md, conda smithy -h, conda-forge.org/docs
  6. New feedstocks
  7. conda-smithy/README.md, conda smithy -h

Conda-smithy Workflow

Conda smithy uses tokens to authenticate with GitHub.

Conda-smithy commands:

Build System Notes

CMake

  1. libpython can be linked statically or dynamically when python is built. It is important for python extensions to be aware of the type of linking in order to avoid segfaults. This can be accomplished by querying Py_ENABLE_SHARED. 

       1 python -c "import sysconfig; print(sysconfig.get_config_var('Py_ENABLE_SHARED'))"

    In EMAN, it is done in cmake/FindPython.cmake

  2. OpenGL detection when Anaconda's compilers are used is done using a cmake toolchain file.

  3. glext.h file needed for OpenGL related module compilation is already present on Linux and Mac. On Windows, it is manually copied once into C:\Program Files\Microsoft SDKs\Windows\v6.0A\Include\gl. On Appveyor it is downloaded as part of env setup every time a test is run.