<Project Name>

Table of Contents

• Overview
• Dependencies
• Getting Started
• Example Usage
• License
• Documentation
• Discussion and Development
• Contributing

Overview

The purpose of this project is...

Dependencies

python=2 sphinx

Getting Started

import <package name>

Note: If you are working in a directory outside the package source file you will need to do one of two things:

1. Manually add the package directory to your sys.path variable:

   import os
   import sys
   
   file_dir = # Input Path to directory of <project package>.
   sys.path.insert(0, file_dir)

2. Install the source code into the you /lib/site-packages directory in your Python instalation folder. Note: This folder should already be in your sys.path variable.

Example Usage

Examples to come

License

Apache License, Version 2.0

Documentation

Sphinx documentation located in the following file: ./docs/build/html/index.html

Discussion and Development

Contributing

If anyone is interested in contributing, ...

Additionally, a contribution guide will need to be created. Style Guide will seek to follow the Python PEP 8 style guide. Doc strings will seek to follow the Numpy docstring guidelines.