How to Contribute?

ADONIS and HYRCAN are free software. Everyone can get involved and contribute to make this project even better. You too can join the the projects no matter if you are developer or not: testers, translators, volunteers providing users support, designers... there's a role for you.

  • Testing and Feedback

  • If you would like to try out the latest and greatest new features and help with testing and feedback, please check out the current development version. Please use the Forum to report the bug and make sure to upload the script as well to be able to recreate the bug.

  • Documentation and Translation

  • Currently ADONIS and HYRCAN have no well documented manual. If you have any suggestions or recommendation and also want to contribute on this regard please let me know.

    Both ADONIS and HYRCAN use Qt to enable multiple language support. One of the very important things you can do for these programs, are to help to translate the program in your language.

    If you are interested to translate text that appears inside the application in your native language (i.e. Spanish, German, French, Turkish etc.) you will have two options as explained below:

    • Translate Directly in the xml File

    • Please go to Download Page (ADONIS or HYRCAN) and download the zip file that provided for this purpose. If you have additional questions or suggestions please go to Forum and share it with other team members.

    • Use Collaborative Online Translation System

    • ADONIS and HYRCAN utilizes a third party collaborative on-line translation system called Crowdin.

      Cover Getting Started Gray

      It is proprietary software but free to FOSS projects. Below are instructions on how to use it:

      1. Go to the ADONIS or HYRCAN translation project page on Crowdin

      2. Login by creating a new profile, or using a third-party account (GitHub, GitLab, GMail etc...).

      3. Click on the language you wish to translate.

      4. Start translating by clicking on the Translate button next to one of the files. For example, ADONIS_en.ts contains the text strings for the ADONIS main GUI.

      5. You can vote for existing translations, or you can create your own.

  • Script Development

  • Both programs come with a powerful and complete JavaScript and Python interfaces. Scripting interface enables the user to define new variables and functions. These functions may be used to extend program's usefulness or add user-defined features. We encourage users to share their input scripts and utility procedures with others. If you have a script or procedure you would like share it with others, please go to the user forum and upload your script.

  • User Defined Constitutive Model (UDCM)

  • In ADONIS, users can define their own constitutive model and integrate the model into the program by using a dynamic-linking library (dll). The created dll should be placed in the installation folder of the program. The program will then detect and load the dll. An example dll including elastic isotropic material can be downloaded from download page. The details on how to create a dll will be provided in the documentation page. ADONIS users, who have developed their own UDCM, are strongly encouraged to contact me for having their UDCM shared with other users and developers. The source code of the UDCM is included in the package, if the developer agrees with the publication.