Metadata-Version: 2.1
Name: skolo
Version: 0.1.0
Summary: A command line tool and python package for SkoloCFD
Home-page: https://github.com/skoloCFD/skolo/
Author: Skolo, LLC
Author-email: admin@skolocfd.com
License: MIT License
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
License-File: LICENSE


The API for SkoloCFD
============================

skolo is the SkoloCFD Software Development Kit (SDK) for Python


Getting Started
---------------
You can install the library using ``pip``

    $ python -m pip install skolo



Or, assuming that you have Python and ``virtualenv`` installed, set up your environment and install the required dependencies like this:

    $ git clone https://github.com/skoloCFD/skolo
    $ cd skolo
    $ virtualenv venv
    ...
    $ . venv/bin/activate
    $ python -m pip install -r requirements.txt
    $ python -m pip install -e .



Configuring Skolo
------------
After installing skolo, you'll need to provide it credential access to the Skolo web server. Instructions for this can be found on the documentation page of the website.

