CIMS is a Python package providing the Python implementation of the CIMS economic climate model.

CIMS is not currently available on PyPi or other package indexes. Follow the installation guide to get CIMS running on your machine.

Once you've installed CIMS you can call its functions and classes from within your own Python script, notebook, or program. Follow the quickstart guide to familiarize yourself with CIMS's key functionality.

import CIMS
model_file = 'path/to/model.xlsb'
my_reader = CIMS.ModelReader(infile=model_file)
my_model = CIMS.Model(my_reader)
my_model.run()

Contributions to CIMS are welcome, in many different forms:

• Issues — If you identify a bug, error in the documentation, or a potential improvement to CIMS, consider putting this information into an issue. First, search the list of existing issues to see if there is an ongoing discussion to join. If a relevant issue doesn't already exist, please create a new issue.
• Code — If you are comfortable writing code feel free to make a Pull Request (PR) with your changes. If you've tackled a large feature request or bug, please also create a new issue, or mention an existing issue within your PR.
• Documentation — If you notice typos, out-of-date information, or opportunities for improvements in the documentation (and are comfortable writing Markdown), please consider making a PR with changes.

Any kind of contribution, whether its fixing a small typo, refactoring existing code, or the implementation of a brand new module helps improve this project.

Bradford Griffin and Jillian Anderson are the project's lead researcher and lead technical developer, respectively.

In addition, contributions to the codebase have been made by members of Simon Fraser University's Big Data Hub and Research Computing Group:

• Steven Bergner
• Rashid Barket
• Maude Lachaine
• Adriena Wong
• Daisy Yu
• Kacy Wu

Finally, thank you to the numerous EMRG graduate students who have attended meetings, submitted features requests, and flagged bugs:

• Thomas Budd
• Aaron Pardy
• Emma Starke
• Kaitlin Thompson
• Heather Chambers
• Ryan Safton

The CIMS Python library is licensed under the MIT License. For more information about this license, checkout this overview.