CairnOpen

Simulation and optimization software for energy and environmental systems.
https://github.com/cea-liten/cairnopen

Category: Energy Systems
Sub Category: Energy System Modeling Frameworks

Last synced: about 2 hours ago
JSON representation

Repository metadata

README.md

Cairn

logo_cairn

πŸ”οΈ Description

Cairn is a simulation and optimization software for energy and environmental systems. It allows for the modeling of technical components and the simulation of their behavior in various scenarios. Cairn is designed to be used in research and engineering environments to evaluate the environmental and economic impacts of energy systems. πŸŒπŸ”
Cairn is developped by the CEA-Liten in Grenoble and ChambΓ©ry.

🌟Features

  • πŸ› οΈ Modeling of technical components.
  • ⚑ Simulation of energy scenarios.
  • 🌳 Evaluation of environmental impacts.
  • πŸ“ˆ Optimization of system configurations, sizing and management.
  • πŸ–₯️ Graphical user interface for configuration and visualization of results.

πŸ› οΈ Prerequisites

Before installing Cairn, ensure your system meets the following prerequisites:

  • Operating System: Windows.
  • C++ compiler compatible with C++17 or higher (for instance CMake)
  • Python 3.13

βš™οΈ Dependencies

  • Qt libraries (version 5.12 or higher).
  • Eigen libraries (version 3.3 or higher).
  • Highs solver
  • Cplex solver (optional, version 20.10)
  • MIPModeler
  • LSET CMakeTools

πŸ“¦ Installation

They are have several options to use Cairn:

  • Cairn Viewer, a graphical interface, can be installed on Windows PC : see releases.
  • Cairn Python API wheels are available on releases.

πŸš€ Usage

To use Cairn, follow these steps:

  • Insall Cairn.
  • Build and configure your model parameters using the graphical user interface or the API.
  • Run the simulation by clicking the "Run" button.
  • View the results in the visualization tabs.

πŸ“š Documentation

For more information on using Cairn, refer to the online documentation.

The documentation of the ongoing version can be found here: integration documentation

πŸ“ž Support

If you encounter any issues or have questions, you can consult the contact technical support at pimprenelle.parmentier at cea point fr.

🀝 Contribution

If you wish to contribute to the development of Cairn, please refer to the CONTRIBUTING.md file for more information on how to submit pull requests and report bugs.

πŸ“œ License

Cairn is distributed under the Eclipse Public Licence V2. For more information, see the LICENSE file.

πŸ“– Cite Cairn

Cairn has been presented in ECOS converence in 2024. The paper is available here.

Please cite as follows:

@inproceedings{ruby:cea-04681216,
  TITLE = {{PERSEE, a single tool for various optimizations of multi-carrier energy system sizing and operation}},
  AUTHOR = {Ruby, Alain and Parmentier, Pimprenelle and Crevon, St{\'e}phanie and Gaoua, Yacine and Piguet, Antoine and Wissocq, Thibaut and Leoncini, Gabriele and Lavialle, Gilles},
  URL = {https://cea.hal.science/cea-04681216},
  BOOKTITLE = {{ECOS 2024 - 37th International Conference on Efficiency, Cost, Optimization, Simulation and Environmental Impact of Energy Systems}},
  ADDRESS = {Rhodes, Greece},
  YEAR = {2024},
  MONTH = Jun,
  PDF = {https://cea.hal.science/cea-04681216v1/file/ECOS2024_Paper_112.pdf},
  HAL_ID = {cea-04681216},
  HAL_VERSION = {v1},
}

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 4 days ago

Total Commits: 72
Total Committers: 3
Avg Commits per committer: 24.0
Development Distribution Score (DDS): 0.403

Commits in past year: 72
Committers in past year: 3
Avg Commits per committer in past year: 24.0
Development Distribution Score (DDS) in past year: 0.403

Name Email Commits
DJEBOUR Youcef HALIAS TECHNOLOGIES y****r@c****r 43
Pimprenelle Parmentier 3****p 20
stephanie-crevon 1****n 9

Committer domains:


Issue and Pull Request metadata

Last synced: 4 days ago

Total issues: 1
Total pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: less than a minute
Total issue authors: 1
Total pull request authors: 1
Average comments per issue: 4.0
Average comments per pull request: 0.0
Merged pull request: 1
Bot issues: 0
Bot pull requests: 0

Past year issues: 1
Past year pull requests: 1
Past year average time to close issues: N/A
Past year average time to close pull requests: less than a minute
Past year issue authors: 1
Past year pull request authors: 1
Past year average comments per issue: 4.0
Past year average comments per pull request: 0.0
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/cea-liten/cairnopen

Top Issue Authors

  • urbanzb (1)

Top Pull Request Authors

  • pimprenellep (1)

Top Issue Labels

Top Pull Request Labels


Dependencies

.github/workflows/documentation.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/jekyll-gh-pages.yml actions
  • actions/checkout v4 composite
  • actions/configure-pages v5 composite
  • actions/deploy-pages v4 composite
  • actions/jekyll-build-pages v1 composite
  • actions/upload-pages-artifact v3 composite
doc/user/requirements.txt pypi
  • breathe ==4.35.0
  • pandas *
  • sphinx ==8.1.3
  • sphinx_rtd_theme ==3.0.1

Score: 3.931825632724326