Skip to content

Update README.md #1588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 23, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions linear_algebra/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Linear algebra library for Python

This module contains some useful classes and functions for dealing with linear algebra in python 2.
This module classes and functions for linear algebra in python 2.

---

## Overview

### class Vector
-
- This class represents a vector of arbitray size and operations on it.
- This class represents a vector of arbitray size and related operations.

**Overview about the methods:**

Expand Down Expand Up @@ -58,22 +58,16 @@ This module contains some useful classes and functions for dealing with linear a

## Documentation

The module is well documented. You can use the python in-built ```help(...)``` function.
For instance: ```help(Vector)``` gives you all information about the Vector-class.
Or ```help(unitBasisVector)``` gives you all information you needed about the
global function ```unitBasisVector(...)```. If you need informations about a certain
method you type ```help(CLASSNAME.METHODNAME)```.
You can use the python in-built ```help(...)``` function. For instance: ```help(Vector)``` provides information about the Vector-class. ```help(unitBasisVector)``` provides information about the global function ```unitBasisVector(...)```. ```help(CLASSNAME.METHODNAME)``` provides information about method 'METHODNAME' from class 'CLASSNAME'.

---

## Usage

You will find the module in the **src** directory its called ```lib.py```. You need to
import this module in your project. Alternative you can also use the file ```lib.pyc``` in python-bytecode.
Import the module ```lib.py``` from the **src** directory into your project. Alternatively, you can use the file ```lib.pyc``` in python-bytecode.

---

## Tests

In the **src** directory you also find the test-suite, its called ```tests.py```.
The test-suite uses the built-in python-test-framework **unittest**.
The test-suite ```tests.py``` found in the **src** directory uses the built-in python-test-framework **unittest**.