coderefinery-documentation-example-project

Example project for coderefinery documentation lesson. This example serves as an exercise to understand how to create good readme files for software development projects. As a bare minimum a README file should include:

• A descriptive project title

• Motivation (why the project exists)

• How to setup

• Copy-pastable quick start code example

• Recommended citation

Temperature analysis in spreadsheets

A python script for the analysis of temperatures in excel files.

Why should I use this project ?

It makes it easy to analyse excel files with temperatures in them.

Setup

You need python>3.5 to run this script.

The project depends on the pandas library, install it with pip: pip install pandas

How to run?

You can run the script from the command-line using

python analyse_spreadsheet.py

You can use functions directly, for example: calculate the mean temperature of some data:

from analyse_spreadsheet import mean_temperature

print(mean_temperature(data))

How to cite this project?

Please email training@esciencecenter.nl to get instructions on how to properly cite this project.

Contributing

You are welcome to contribute to the code via pull requests. Please have a look at the NLeSC guide for guidelines about software development.