Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary
Repository
Basic Info
Statistics
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 75
- Releases: 1
Metadata Files
README.md
CIMS
CIMS is a Python package providing the Python implementation of the CIMS economic climate model.
:gear: Installation
CIMS is not currently available on PyPi or other package indexes. Follow the installation guide to get CIMS running on your machine.
:technologist: Usage
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()
:memo: Contributing
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.
:book: Citation
:pray: Acknowledgements
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
:balance_scale: License
The CIMS Python library is licensed under the MIT License. For more information about this license, checkout this overview.
Owner
- Name: EMRG-SFU
- Login: EMRG-SFU
- Kind: organization
- Repositories: 1
- Profile: https://github.com/EMRG-SFU
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: CIMS energy-economy model
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Brad
family-names: Griffin
email: bradford_griffin@sfu.ca
affiliation: Simon Fraser University
- given-names: Jillian
family-names: Anderson
email: jillian_anderson@sfu.ca
affiliation: Simon Fraser University
orcid: 'https://orcid.org/0000-0002-2528-2580'
- given-names: Matthew
family-names: Sniatynski
email: matt@exmath.org
affiliation: The Laboratory for Experimental Mathematics Inc.
- given-names: Thomas
family-names: Budd
email: tbudd@sfu.ca
affiliation: Simon Fraser University
- given-names: Emma
family-names: Starke
email: emma_starke@sfu.ca
affiliation: Simon Fraser University
repository-code: 'https://github.com/EMRG-SFU/cims'
repository: 'https://github.com/EMRG-SFU/cims-models'
abstract: >-
CIMS is an integrated energy-economy model designed to
provide information to policy makers on the likely
response of firms and households to policies that
influence their technology acquisition and use decisions.
As a technology simulation model, it reflects how people
actually behave rather than how they ought to behave (as
in cost minimization modelling). CIMS is able to provide
policy makers with information on: (1) the ability of
policies to achieve specific objectives (like greenhouse
gas emissions reductions), (2) the likely costs of
achieving these objectives, and (3) the uncertainties
associated with the model’s simulations.
CIMS is maintained and operated by the Energy and
Materials Research Group at the School of Resource and
Environmental Management at Simon Fraser University in
Burnaby, B.C., Canada.
Funding for the development of the initial version of this
project was provided by the Pacific Institute for Climate
Solutions Opportunity Projects Program, Natural Resources
Canada, and Environment and Climate Change Canada.
keywords:
- energy
- emissions
- policy
- simulation
- jupyter-notebook
- networkx
- polars
- ipwidgets
- plotly
license: MIT
version: '0.1'
date-released: '2025-03-03'
GitHub Events
Total
- Create event: 1
- Release event: 1
- Issues event: 5
- Push event: 4
- Public event: 1
- Pull request event: 2
Last Year
- Create event: 1
- Release event: 1
- Issues event: 5
- Push event: 4
- Public event: 1
- Pull request event: 2
Committers
Last synced: 8 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Jillian Anderson | 1****8 | 296 |
| Brad Griffin | b****n@s****a | 153 |
| Kacy Wu | K****2@g****m | 20 |
| mlachain | m****n@s****a | 18 |
| rbarket | b****d@h****m | 16 |
| “yya188” | “****8@s****” | 12 |
| Matt | m****t@M****P | 8 |
| Maude Lachaine | m****e@S****l | 6 |
| Steven Bergner | g****b | 4 |
| Maude Lachaine | m****e@d****a | 4 |
| rbarket | 5****t@u****a | 4 |
| Daisy Yu | 1****8@u****a | 2 |
| Maude Lachaine | m****e@S****e | 2 |
| yya188 | y****8@s****a | 2 |
| Kacy Wu | 5****8@u****a | 1 |
| Maude Lachaine | m****e@M****e | 1 |
| Maude Lachaine | m****e@d****a | 1 |
| Maude Lachaine | m****e@d****a | 1 |
| Maude Lachaine | m****e@d****a | 1 |
| Maude Lachaine | m****e@d****a | 1 |
| Maude Lachaine | m****e@d****a | 1 |
| Maude Lachaine | m****e@d****a | 1 |
| adrienaw | 5****w@u****a | 1 |
| matt-exmath | 1****h | 1 |
| EvanDungate | e****e@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 72
- Total pull requests: 28
- Average time to close issues: about 2 months
- Average time to close pull requests: 14 days
- Total issue authors: 6
- Total pull request authors: 3
- Average comments per issue: 1.31
- Average comments per pull request: 0.39
- Merged pull requests: 26
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 69
- Pull requests: 27
- Average time to close issues: about 2 months
- Average time to close pull requests: 11 days
- Issue authors: 6
- Pull request authors: 3
- Average comments per issue: 1.35
- Average comments per pull request: 0.3
- Merged pull requests: 25
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- brad-griffin (35)
- jillianderson8 (28)
- matt-exmath (4)
- tcbudd (3)
- ees88 (1)
- gabi-diner-cer (1)
Pull Request Authors
- jillianderson8 (21)
- brad-griffin (5)
- matt-exmath (4)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- jupyter
- matplotlib
- networkx
- numpy
- pandas >=2
- pip
- polars
- pyarrow
- python >=3.11
- scipy
- seaborn >=0.13.2
- setuptools
- xlrd
- matplotlib *
- networkx *
- numpy *
- packaging *
- pandas >=1.2
- polars *
- pyarrow *
- pyxlsb *
- requests *
- scipy *
- seaborn >=0.13.2
- tqdm *
- wasabi *
- xlrd *