Skip to content

Latest commit

 

History

History
84 lines (67 loc) · 2.71 KB

README.md

File metadata and controls

84 lines (67 loc) · 2.71 KB
Raw
                  ___________    ____
  ________ __ ___/ / ____/   |  / __ \
 / ___/ __` / __  / /   / /| | / / / /
/ /__/ /_/ / /_/ / /___/ ___ |/ /_/ /
\___/\__,_/\__,_/\____/_/  |_/_____/
by cadCAD                  ver. 0.4.23
======================================
       Complex Adaptive Dynamics       
       o       i        e
       m       d        s
       p       e        i
       u       d        g
       t                n
       e
       r

cadCAD is a Python package that assists in the processes of designing, testing and validating complex systems through simulation, with support for Monte Carlo methods, A/B testing and parameter sweeping.

Getting Started

Change Log: ver. 0.4.23

Previous Stable Release (No Longer Supported)

0. Pre-installation Virtual Environments with venv (Optional):

If you wish to create an easy to use virtual environment to install cadCAD inside of, please use the built in venv package.

Create a virtual environment:

$ python3 -m venv ~/cadcad

Activate an existing virtual environment:

$ source ~/cadcad/bin/activate
(cadcad) $

Deactivate virtual environment:

(cadcad) $ deactivate
$

1. Installation:

Requires >= Python 3.6

Option A: Install Using pip

$ pip3 install cadCAD

Option B: Build From Source

$ pip3 install -r requirements.txt
$ python3 setup.py sdist bdist_wheel
$ pip3 install dist/*.whl

Option C: Using Nix

  1. Run curl -L https://nixos.org/nix/install | sh or install Nix via system package manager
  2. Run nix-shell to enter into a development environment, nix-build to build project from source, and nix-env -if default.nix to install

The above steps will enter you into a Nix development environment, with all package requirements for development of and with cadCAD.

This works with just about all Unix systems as well as MacOS, for pure reproducible builds that don't affect your local environment.

2. Documentation:

3. Connect:

Find other cadCAD users at our Discourse. We are a small but rapidly growing community.

4. Contribute!