Skip to content

Latest commit

 

History

History
24 lines (13 loc) · 1.5 KB

README.md

File metadata and controls

24 lines (13 loc) · 1.5 KB
Raw

OpenPNM-Examples

A collection of scripts illustrating the use of OpenPNM

Note: This repository is still being setup. Please be patient while we organize and adjust things.

The files in these folders are written in either reStructuredText, MarkDown, or IPythonNotebook format, which allows for an useful blend of formatted text and highlighted code.

How to Contribute an Example to this Collection

We strongly encourage you to create an example and post it in this collection. The procedure is straightforward and can be explained in just a few lines:

  1. Fork this repository to your own Github account using the 'Fork' button on the Github website. This will let you make edits and additions to the repository without needing write permission.

  2. Create your example using the instructions below, and push your changes to your forked version of the repository. You can edit and push as many times as needed to check how the document looks when Github renders it.

  3. Make a pull request using the Github website by going the 'Pull Requests' tab on your forked repository, and then selecting the 'New pull request' button.

How to Write an Example

This section introduces a few rules and tips for creating nicely formatted documents that would be suitable for inclusion here.

MarkDown Tips: If you need some help on MarkDown formatting and notation, checkout the cheatsheet.