Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

74 lines (48 loc) · 3.21 KB

Contributing to tobac

Welcome! We are very happy that you are interested in our project and thanks for taking time to contribute! :)

We are currently reorganizing our project. So, please check our modifications later.

Getting Started

Installation & Environment details

You will find them in the README.md.

Tutorials

Tutorials have been prepared to provide you further inside to tobacs functionality. Please visit the separate tobac-tutorials repository here on Github.

Documentation

You will find our documentation at https://tobac.readthedocs.io.

Testing

The tests are located in the tests folder.

Reporting Bugs

Please create a new issue on GitHub if it is not listed there, yet.

How to write a good Bug Report?

  • Give it a clear descriptive title.
  • Copy and paste the error message.
  • Describe the steps for reproducing the problem and give an specific example.
  • Optional: Make a suggestion to fix it.

How to Submit Changes

  • Please read the README.md first, to learn about our project goals and check the changelog.md.
  • Before you start a pull request, please make sure that you added numpydoc docstrings to your functions. This way the api documentation will be parsed properly.
  • If it is a larger change or an newly added feature or workflow, please place an example of use in the tobac-tutorials repository or adapt the existing examples there.
  • If necessary add a folder or modify a file.
  • The code should be PEP 8 compliant, as this facilitates our collaboration. Please use the latest version of black to format your code. When you submit a pull request, all files are checked for formatting.

We hope that we can respond within two weeks.

Numpydoc Example 

  
   '''
   calculate centre of gravity and mass forech individual tracked cell in the simulation


    Parameters
    ----------
    tracks : pandas.DataFram
        DataFrame containing trajectories of cell centres
        
    param mass : iris.cube.Cube
        cube of quantity (need coordinates 'time', 'geopotential_height','projection_x_coordinate' and 
        'projection_y_coordinate')
        
    param mask : iris.cube.Cube
        cube containing mask (int > where belonging to cloud volume, 0 everywhere else )


    Returns
    -------
    track_out : pandas.DataFrame
        Dataframe containing t,x,y,z positions of centre of gravity and total cloud mass each tracked cells 
        at each timestep
    
    '''

Slack

In addition to the workflow here on Github, there's a tobac workspace on Slack tobac-dev.slack.com that we use for some additional communication around the project. Please join us there to stay updated about all things tobac that go beyond the detailed work on the code.