{"id":180021,"date":"2023-12-01T13:02:09","date_gmt":"2023-12-01T13:02:09","guid":{"rendered":"\/knowledge\/?post_type=topic&#038;p=180021"},"modified":"2025-12-08T18:49:33","modified_gmt":"2025-12-08T18:49:33","slug":"rocky-sdk-package-api-solver","status":"publish","type":"topic","link":"https:\/\/innovationspace.ansys.com\/knowledge\/forums\/topic\/rocky-sdk-package-api-solver\/","title":{"rendered":"Customize with Ansys Rocky Solver SDK Package"},"content":{"rendered":"<p><span style=\"font-size: 12.0pt;font-family: 'Source Sans Pro', sans-serif\"> Through the <strong>Rocky Solver SDK<\/strong> you can write your own modules (add-ins) to add customized features to your simulations such as contact models, external forces, special conditions, gather extra information directly from the solver and much more.<\/span><\/p>\n<p><iframe loading=\"lazy\" title=\"Ansys Rocky: How To Create Custom Modules\" width=\"640\" height=\"360\" src=\"https:\/\/www.youtube.com\/embed\/UMM-63fl3Lk?list=PL0lZXwHtV6Omiv62KRuPbnZ4oBK8BmDit\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" referrerpolicy=\"strict-origin-when-cross-origin\" allowfullscreen><\/iframe><\/p>\n<h3  id=\"WHAT-IS-A-ROCKY-CUSTOM-MODULE\"><strong><span style=\"font-size: 50px;font-weight: 900;color: #fedb8d\">\/<\/span>What is a Rocky Custom Module?<\/strong><\/h3>\n<p><span style=\"font-size: 12.0pt;font-family: 'Source Sans Pro', sans-serif\"> An Ansys Rocky Custom Module is a compiled library that attaches to the Rocky solver at strategic points during the simulation, allowing the execution of a <strong>custom code<\/strong>.<\/span><\/p>\n<p>&nbsp;<\/p>\n<h3  id=\"WHAT-THE-ROCKY-SOFTWARE-DEVELOPMENT-KIT-SDK-IS-USED-FOR\"><strong><span style=\"font-size: 50px;font-weight: 900;color: #fedb8d\">\/<\/span>What the Rocky Software Development Kit (SDK) is used for?<\/strong><\/h3>\n<p><span style=\"font-size: 12.0pt;font-family: 'Source Sans Pro', sans-serif\">The Rocky Software Development Kit (SDK) is used to built your custom module code once it is ready, allowing you to use it in your Rocky simulations.<\/span><\/p>\n<h3  id=\"\"><\/h3>\n<h3  id=\"CAN-I-USE-THE-SOURCE-CODE-OF-THE-ALREADY-CREATED-ROCKY-MODULES-TO-START-CREATING-MY-OWN\"><strong><span style=\"font-size: 50px;font-weight: 900;color: #fedb8d\">\/<\/span>Can I use the source code of the already created Rocky Modules to start creating my own?<\/strong><\/h3>\n<p><span style=\"font-size: 12.0pt;font-family: 'Source Sans Pro', sans-serif\">Yes, you do not need to start your <strong>custom code<\/strong> from scratch, along with the SDK, you can download the source code of some of the <a href=\"\/knowledge\/forums\/topic\/ready-to-use-module\/\"><strong>Ready-to-use modules<\/strong><\/a>, the source code of some of <strong>Rocky&#8217;s current features<\/strong>, and also have some <strong>code examples<\/strong> that can help you with your project.<\/span><\/p>\n<p>&nbsp;<\/p>\n<h3  id=\"IS-THERE-A-MANUAL-OR-TUTORIAL-WHERE-I-CAN-LEARN-MORE-ABOUT-HOW-TO-CREATE-MY-OWN-MODULES\"><strong><span style=\"font-size: 50px;font-weight: 900;color: #fedb8d\">\/<\/span>Is there a manual or tutorial where I can learn more about how to create my own modules?<\/strong><\/h3>\n<p><span style=\"font-size: 12.0pt;font-family: 'Source Sans Pro', sans-serif\">Yes, the <a href=\"https:\/\/developer.ansys.com\/docs\/rocky\">Solver SDK manual<\/a> is available on the\u00a0<a href=\"https:\/\/developer.ansys.com\/docs\/rocky\"> Ansys Developer Portal<\/a> and there you will find instructions and technical details to create your own Rocky modules, and through <a href=\"https:\/\/ansyshelp.ansys.com\/account\/secured?returnurl=\/Views\/Secured\/corp\/v251\/en\/dem_tut\/dem_tut_23.html\">Tutorial 23 &#8211; Solver SDK<\/a> you will learn how to install and configure the working environment for the Rocky Solver SDK (Software Development Kit), and how to use the Rocky Solver SDK to build a simple custom module.<\/span><\/p>\n<p>&nbsp;<\/p>\n<div class=\"packages-rocky\">\n<div class=\"additional-package-rocky col-md-5\">\n<p><span style=\"font-family: 'Source Sans Pro', sans-serif;font-size: 12.0pt\"><strong>Download Package:<\/strong> To download the SDK and Source Codes, scroll down to <strong>Add-ons Packages<\/strong>, and in <strong>Ansys Rocky<\/strong> click on <strong>SDK and Modules. <\/strong>To learn more about each available source code and how to use the SDK, review the Installation Guide Modules &amp; Scripts within the package.<\/span><\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-medium wp-image-214653\" style=\"border-radius: 0\" src=\"\/knowledge\/wp-content\/uploads\/sites\/4\/2024\/01\/MicrosoftTeams-image-4-300x238.png\" alt=\"\" width=\"300\" height=\"185\" \/><\/p>\n<div><i class=\"fa fa-download\" aria-hidden=\"true\"><\/i><br \/>\n<a class=\"download\" href=\"https:\/\/download.ansys.com\/Current%20Release\" target=\"_blank\" rel=\"noopener\">DOWNLOAD PACKAGE<\/a><\/div>\n<\/div>\n<\/div>\n","protected":false},"template":"","class_list":["post-180021","topic","type-topic","status-publish","hentry"],"aioseo_notices":[],"acf":[],"custom_fields":[{"0":{"_edit_lock":["1765220579:17114"],"_edit_last":["17114"],"application_name":[""],"_application_name":["field_64a80903c8e15"],"family":[""],"_family":["field_64a809229a857"],"siebel_km_number":[""],"_siebel_km_number":["field_63ecbffce60db"],"salesforce_km_number":[""],"_salesforce_km_number":["field_63ecc018e60dc"],"km_published_date":[""],"_km_published_date":["field_64c77704499dd"],"product_version":[""],"_product_version":["field_64c776cb4fd2e"],"_bbp_forum_id":["180025"],"_bbp_topic_id":["197787"],"_bbp_author_ip":["23.206.193.47"],"_bbp_last_reply_id":["0"],"_bbp_last_active_id":["180022"],"_bbp_last_active_time":["2023-12-01 13:02:09"],"_bbp_reply_count":["0"],"_bbp_reply_count_hidden":["0"],"_bbp_voice_count":["0"],"_yoast_wpseo_content_score":["90"],"_yoast_wpseo_estimated-reading-time-minutes":["2"],"_yoast_wpseo_wordproof_timestamp":[""],"_btv_view_count":["5616"],"filter_by_optics_product":["Lumerical"],"_filter_by_optics_product":["field_64fb192ba3121"],"_aioseo_title":[null],"_aioseo_description":[null],"_aioseo_keywords":["a:0:{}"],"_aioseo_og_title":[null],"_aioseo_og_description":[null],"_aioseo_og_article_section":[""],"_aioseo_og_article_tags":["a:0:{}"],"_aioseo_twitter_title":[null],"_aioseo_twitter_description":[null],"_oembed_80009e41d21bd91422c3867ed27791df":["<iframe title=\"Ansys Rocky: How To Create Custom Modules\" width=\"640\" height=\"360\" src=\"https:\/\/www.youtube.com\/embed\/UMM-63fl3Lk?list=PL0lZXwHtV6Omiv62KRuPbnZ4oBK8BmDit\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" referrerpolicy=\"strict-origin-when-cross-origin\" allowfullscreen><\/iframe>"],"_oembed_time_80009e41d21bd91422c3867ed27791df":["1765219190"]},"test":"articlesansys-com"}],"_links":{"self":[{"href":"https:\/\/innovationspace.ansys.com\/knowledge\/wp-json\/wp\/v2\/topics\/180021","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/innovationspace.ansys.com\/knowledge\/wp-json\/wp\/v2\/topics"}],"about":[{"href":"https:\/\/innovationspace.ansys.com\/knowledge\/wp-json\/wp\/v2\/types\/topic"}],"version-history":[{"count":19,"href":"https:\/\/innovationspace.ansys.com\/knowledge\/wp-json\/wp\/v2\/topics\/180021\/revisions"}],"predecessor-version":[{"id":197787,"href":"https:\/\/innovationspace.ansys.com\/knowledge\/wp-json\/wp\/v2\/topics\/180021\/revisions\/197787"}],"wp:attachment":[{"href":"https:\/\/innovationspace.ansys.com\/knowledge\/wp-json\/wp\/v2\/media?parent=180021"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}