Skip to content
This repository has been archived by the owner on Jul 23, 2018. It is now read-only.

bjodah/algmoid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

algmoid

https://travis-ci.org/bjodah/algmoid.png?branch=master

"algmoid" is a C++11 implementation (including native Python bindings) of algebraic sigmoidal functions of form:

s(x) := x*((x/lim)**n + 1)**(-1/n)

Feel free to enhance modify and make pull request at github to the algmoid repository.

Installation

See dependencies and make sure that manual dependencies are satisfied.

Example using pip (modify to your own needs):
  1. pip install --user --upgrade -r https://raw.github.com/bjodah/algmoid/v0.0.1/requirements.txt
  2. pip install --user --upgrade https://github.com/bjodah/algmoid/archive/v0.0.1.tar.gz
Manual installation:
  1. Clone repository git clone https://github.com/bjodah/algmoid.git
  2. Install dependencies cd algmoid; pip install --user --upgrade -r requirements.txt
  3. To install run python setup.py install --user or sudo python setup.py install.

See distutils documentation for more options.

Note that the behaviour of setup(...) is modified slightly through the use of "CleverExtension" from pycompilation.

Tests

To run the full test suite, you need to build the python bindings. (see Dependencies) 1. python setup.py build_ext --inplace 2. py.test

Dependencies

You need a C++ compiler supporting C++11 (-std=c++0x) On a debian based linux system you can install it easily by typing: sudo apt-get install g++

Optional dependencies (for Python bindings):

  • Python header files (sudo apt-get install python-dev)
  • Python (tested with 2.7)
  • NumPy
  • Cython
  • pycompilation (optional: enables use from python)
  • pytest (sudo apt-get install python-pytest)

See requirements.txt for detailed information of versions tested for.

For all dependencies the following command may be issued on a debian based system: sudo apt-get install g++ python2.7 libpython2.7-dev python-numpy cython python-pip python-pytest; sudo pip install --upgrade -r https://raw.github.com/bjodah/algmoid/v0.0.1/requirements.txt

License

Open Source. Released under the very permissive "simplified (2-clause) BSD license". See LICENSE.txt for further details.

Authors

Björn Dahlgren.

TODO

Write proper documentation.

About

Algebraic Sigmoids in C++11 with Python wrapper.

Resources

License

Stars

Watchers

Forks

Packages

No packages published