trk9001/cimbolicparser

Irregularly updated clone of the CimbolicParser repo on Azure DevOps (Cimplux).

Cimbolic Language & Parser

Cimbolic is a custom mathematical language and parser library consisting of variables and their associated formulae (pairs of conditions and arithmetic rules). The project is under development in and by Cimplux.

Other details:

• Project type: Reusable Django application
• Project starting date: 27 August 2019
• Contributors:
  • A. G. M. Imam Hossain
  • Sharif M. Tarik

Usage

Setting up

1. Install the source distribution using pip.

2. Add Cimbolic to your INSTALLED_APPS in settings.py:

    INSTALLED_APPS = [
        # your other apps here
        'cimbolic',
    ]
   

3. Run python manage.py migrate to create the Variable and Formula tables.

Defining system-sourced variables

1. Create a file called cimbolic_vars.py in your project's root directory and add system-sourced variables to it as shown in the example file provided.

2. Run python manage.py loadvars to load the system-sourced variables into the database.

3. For more info, please ask the contributors directly.

Managing user-sourced variables

1. For info, please ask the contributors directly.

To be done

• Set up versioning
• Write tests using pytest (see pytest-django)
• Confirm stakeholders in README.md
• Set up CI/CD and hosting
• Set up a git flow workflow
• Add docs
• Add a changelog
• Add Django forms

Copyright

Copyright (c) 2019 Cimplux
All rights reserved.