Skip to content

Latest commit

 

History

History
104 lines (68 loc) · 2.16 KB

ADMINISTRATA.md

File metadata and controls

104 lines (68 loc) · 2.16 KB
Raw

Administata

Basic administrative procedures.

Merging

  • Push all branches for code review before merging to master.

  • The reviewer should test code integrity.

  • The author of the branch should not merge.

Code Integrity

  • Use Pylint

  • Run autopep8

  • Use the package "coverage" to check test coverage

Docs

Steps to install

$ pip install sphinx
$ pip install sphinx_bootstrap_theme
$ pip install sphinxcontrib-napoleon
$ cd doc/
$ make

The documentation should be in _build/html.

Branching

  • In general make an issue before a major branch and call the branch "issueXX-my_branch".

  • Use Fix #XX, when merging the branch if issues is fixed and address #XX for all commits.

Commit Messages

Run tests before comitting. Use the following template:

# Header, 50 characters or less
#
# Links to tickets, fixes etc
#
# Main Message
#
# List of other changes
#
# Answer the following questions:
#
#   * Why is this change necessary?
#
#   * How does it address the issue?
#
#   * What side effects does this change have?

Docker

The Dockerfile is for Binder, but can be used locally. To install Docker go to https://docs.docker.com/engine/installation/ and install for your OS. Start up the deamon.

$ sudo service docker run

To run this PyMKS instance first pull the instance from Dockerhub

$ docker pull docker.io/wd15/pymks

and then run the instance with

$ docker run -i -p 8888:8888 -t wd15/pymks:latest

and then launch the notebook server

$ ipython notebook --no-browser

and view the notebooks in the browser http://localhost:8888.

Build the Docker instance

$ docker build --no-cache -t wd15/pymks:latest .

in the base PyMKS directory. To push the instance use

$ docker login
$ docker push docker.io/wd15/pymks:latest

The official PyMKS instance is at https://hub.docker.com/r/wd15/pymks/.