API
collimator.dashboard.project
Project
Represents a project in the Collimator dashboard.
Source code in collimator/dashboard/project.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
|
__init__(summary, models, files, submodels, init_scripts=None)
Initialize a new Project instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
summary |
ProjectSummary
|
The summary of the project. |
required |
models |
dict[str, Model]
|
A dictionary of models associated with the project. The keys are the model names and the values are the json representations of the models. |
required |
files |
list[str]
|
A list of file paths associated with the project. |
required |
submodels |
dict[str, str]
|
A dictionary of submodels associated with the project. The keys are the submodel names and the values are the reference IDs of the submodels. |
required |
init_scripts |
dict[str, InitScriptVariables]
|
A dictionary of initialization scripts associated with the project. Defaults to None. |
None
|
Source code in collimator/dashboard/project.py
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
|
create_submodel_instance(name, instance_name, instance_parameters=None, **kwargs)
Creates an instance of a submodel.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the submodel. |
required |
instance_name |
str
|
The name of the instance. |
required |
instance_parameters |
dict[str, Any]
|
Parameters for the instance. Defaults to None. |
None
|
**kwargs |
Additional keyword arguments. |
{}
|
Returns:
Name | Type | Description |
---|---|---|
Diagram |
Diagram
|
The created submodel instance. |
Raises:
Type | Description |
---|---|
KeyError
|
If the specified submodel is not found. |
ValueError
|
If the specified submodel is found but has a None reference ID. |
Source code in collimator/dashboard/project.py
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
|
get_model(name)
Retrieves a model from the project.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the model to retrieve. |
required |
Returns:
Name | Type | Description |
---|---|---|
SimulationContext |
SimulationContext
|
The simulation context for the retrieved model. |
Raises:
Type | Description |
---|---|
KeyError
|
If the specified model name is not found. |
Source code in collimator/dashboard/project.py
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
|
save_model(diagram, configuration=None)
Save the given diagram as a model. If the diagram already exists, it will be updated.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
diagram |
Diagram
|
The diagram to be saved as a model. |
required |
configuration |
Configuration
|
The configuration for the model. Defaults to None. |
None
|
Returns:
Type | Description |
---|---|
str
|
The UUID of the saved model. |
Source code in collimator/dashboard/project.py
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
|
save_submodel(constructor, name, default_parameters=None)
Saves a submodel with the given reference ID and name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
constructor |
Callable
|
The constructor function for the submodel. |
required |
name |
str
|
The name of the submodel. |
required |
default_parameters |
list[Parameter]
|
A list of default parameters for the submodel. Defaults to None. |
None
|
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The reference ID of the saved submodel. |
Source code in collimator/dashboard/project.py
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 |
|
create_project(name)
Creates a new project with the given name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the project. |
required |
Returns:
Name | Type | Description |
---|---|---|
ProjectSummary |
Project
|
The summary of the created project. |
Source code in collimator/dashboard/project.py
573 574 575 576 577 578 579 580 581 582 583 584 585 586 |
|
delete_project(project_uuid)
Deletes a project with the given UUID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_uuid |
str
|
The UUID of the project to delete. |
required |
Source code in collimator/dashboard/project.py
605 606 607 608 609 610 611 612 613 |
|
get_or_create_project(name)
Retrieves a project by its name or creates a new one if it doesn't exist.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the project. |
required |
Returns:
Name | Type | Description |
---|---|---|
ProjectSummary |
Project
|
The summary of the retrieved or created project. |
Source code in collimator/dashboard/project.py
589 590 591 592 593 594 595 596 597 598 599 600 601 602 |
|
get_project_by_name(project_name)
Retrieves a project by its name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_name |
str
|
The name of the project to retrieve. |
required |
project_dir |
str
|
The directory where the project is located. If not provided, a temporary directory will be created. |
required |
Returns:
Name | Type | Description |
---|---|---|
Project |
Project
|
The project object. |
Raises:
Type | Description |
---|---|
CollimatorNotFoundError
|
If the project with the specified name is not found. |
CollimatorApiError
|
If multiple projects with the same name are found. |
Source code in collimator/dashboard/project.py
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
|
get_project_by_uuid(project_uuid)
Retrieves a project with the given UUID and downloads its files.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_uuid |
str
|
The UUID of the project to retrieve. |
required |
Returns:
Name | Type | Description |
---|---|---|
Project |
Project
|
The downloaded project, including its models and files. |
Source code in collimator/dashboard/project.py
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
|
simulate(model_uuid, timeout=None, ignore_cache=False, parameters=None)
async
Runs a simulation for the specified model UUID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_uuid |
str
|
The UUID of the model to run the simulation for. |
required |
timeout |
int
|
The maximum time to wait for the simulation to complete, in seconds. Defaults to None. |
None
|
Returns:
Name | Type | Description |
---|---|---|
SimulationResults |
SimulationResults
|
The results of the simulation. |
Raises:
Type | Description |
---|---|
TimeoutError
|
If the simulation does not complete within the specified timeout. |
SimulationFailedError
|
If the simulation fails. |
Source code in collimator/dashboard/project.py
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 |
|
stop_simulation(model_uuid, simulation_uuid)
Stops a running simulation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_uuid |
str
|
The UUID of the model for which the simulation is running. |
required |
simulation_uuid |
str
|
The UUID of the simulation to stop. |
required |
Returns:
Name | Type | Description |
---|---|---|
dict |
dict
|
The response from the API call. |
Source code in collimator/dashboard/project.py
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
|
upload_file(project_uuid, name, fp, overwrite=True)
Uploads a file to a project.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_uuid |
str
|
The UUID of the project. |
required |
name |
str
|
The name of the file. |
required |
fp |
IO[AnyStr]
|
The file pointer of the file to be uploaded. |
required |
overwrite |
bool
|
Flag indicating whether to overwrite an existing file with the same name. Defaults to True. |
True
|
Returns:
Name | Type | Description |
---|---|---|
dict |
A dictionary containing the summary of the uploaded file. |
Raises:
Type | Description |
---|---|
CollimatorApiError
|
If the file upload fails. |
Source code in collimator/dashboard/project.py
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 |
|
upload_files(project_uuid, files, overwrite=True)
Uploads multiple files to a project.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_uuid |
str
|
The UUID of the project. |
required |
files |
list[str]
|
A list of file paths to be uploaded. |
required |
overwrite |
bool
|
Flag indicating whether to overwrite existing files. Defaults to True. |
True
|
Source code in collimator/dashboard/project.py
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 |
|