Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

56 lines (42 loc) · 2.5 KB
Raw

Contributor's Guidelines

Reporting bugs and any problem you encounter with HyMD is the most important contribution to us.
You can do that by submitting them (along with feature requests) on the issue tracker.

If you want to contribute your own code, this short guide takes you through the necessary steps.

  1. Getting started
    Fork the repository from here. Clone the fork on your local machine and install the dependencies following the instructions given in the documentation.

    Finally install the package in development mode using

    cd HyMD_fork
pip install -e .

  2. Contribute
    Write your code, test it (we welcome setting up tests with pytest) and follow the instructions here to make sure it runs correctly.

    If you are contributing new Fortran routines, you need to include the files in the force_kernel extension in setup.py so they can be compiled with f2py when running pip install. We also require both a single and double precision version of the routines.

    To import them inside Python you simply call

    from force_kernel import <routine_name>

  3. Open a pull request (PR)
    When you feel ready you can open a PR to merge your contributions in the main HyMD branch. Add a simple title and give a short description of the PR, explaining what problem you are trying to solve or what feature is being implemented. Once the PR is submitted we will review it and provide feedback.

Code style

For python files we follow the PEP8 guidelines, so please adapt to them when implementing new code.

The most important stylistic requirements are:

use 4 spaces for indentation instead of tabs
wrap lines to max 80 characters whenever possible
name variables and functions all lowercase with underscore as a separator (e.g. some_variable)
name classes with starting letters capitalized and no separator (e.g. SomeClass)

While for Fortran the basic requirements are:

use 2 spaces for indentation
wrap lines to max 80 characters whenever possible
do not use 'goto' statements
use lowercase for commands and functions