Lenty / SLiCAP_python

Open-source version of SLiCAP, implemented in python
Other
33 stars 15 forks source link

SLiCAP: more than SYMBOLIC SPICE

What it is

Why you should use it

Features

Capabilities

Technology

Setting up SLiCAP

To set up SLiCAP, the following components are required:

The dependencies are listed in the 'requirements.txt' file.

  1. Download or clone the SLiCAP archive from github
  2. Extract it in some directory
  3. Open a terminal or an Anaconda terminal if you run python from Anaconda in the directory with setup.py
  4. Enter: 'python setup.py install --user

Project file locations

Do not place project files in the directory where SLiCAP installs the libraries, the examples, and the documentation.

This location defaults to: /home/yourUserName/SLiCAP/ (LINUX) or \users\yourUserName\SLiCAP\ (WINDOWS).

The contents of this directory will be overwritten if you re-install or update SLiCAP.

First Run

To verify setting up of SLiCAP has been done correctly, it is possible to run one of the example projects that are in the examples/ directory.

Documentation

By default, the documentation is placed in /home/yourUserName/SLiCAP/docs/ (LINUX) or \users\yourUserName\SLiCAP\docs\ (WINDOWS). Execution of the SLiCAP command 'Help()' shows the HTML documentation in your dfefault browser.

Contributing

This github page is to be used for contributing to SLiCAP.

Adding features

Features should be added through pull requests and pass all checks that have been set up on the github page. These tests include:

Bugs

In case bugs are found, please report them to the 'Issues' page where we can resolve the issues and keep track of any possible bugs.

Build Status