Clone wiki

mss / GSOC2019 / Getting Started

FAQ How To Start

  • Where is the link to a setup guide for new developers?

  • Are there any unusual libraries/applications that need to be installed first?

    We are based on anaconda3 and conda-forge. The next upcoming major release is based on python 3. The current stable works with python 2 and python 3. All development is done with python 3.

    On linux install xvfb. This is used to run tests on a virtual display.

  • How do I have to setup my environment?

    Dependent on the IDE there are differences, we try to describe this for anycase.

    • After you installed by conda-forge all mss dependencies by conda install mss uninstall mss from your env (conda remove mss).
    • conda install isodate
    • update matplotlib > 3.0.0
    • Add the path of your development mss directory to $PYTHONPATH
    • Verify by pytest in your mss directory that tests are executed
    • python workspace/mss/mslib/mswms/ (see output on screen)
    • python workspace/mss/mslib/mswms/
    • python workspace/mss/mslib/msui/
  • What type of source control do you use?

  • Which branch have I to use?

    We have two branches in the project.

    • stable is meant for bugfixes only of the current major release.
    • develop is for all kind of development. This is the branch which is used for new features and API changes. develop should always be in a functional state. If you work on something you make a new branch based on develop in your repository.
  • What's the process for submitting your first bug fix?

    We like to have a fork of the project, creating a branch based on the develop branch, claiming an issue, working on that issue, talking about that, sending a pull request

  • Where should students look to find easy bugs to try out?

    Issues to start with

Back to Overview