... | ... | @@ -9,22 +9,22 @@ Please be aware that we, as MBDyn developers, believe strongly in the [free](htt |
|
|
|
|
|
### How to contribute
|
|
|
There are different ways you can contribute to MBDyn. For example:
|
|
|
- using it and reporting bugs (for example opening an [issue](https://public.gitlab.polimi.it/Pub/mbdyn/issues)), fixing/adding tutorials, documentation, suggesting new features to
|
|
|
- using it and reporting bugs (for example opening an [issue](https://public.gitlab.polimi.it/DAER/mbdyn/issues)), fixing/adding tutorials, documentation, suggesting new features to
|
|
|
be added to the [TODO list](https://www.mbdyn.org/?Developers_corner___TODO_list), and so on;
|
|
|
- submitting code that fix bugs or implement new features, and so on;
|
|
|
- establishing a grant with [DAER/Polimi](http://www.aero.polimi.it/) to implement the features or develop the models you need (to establish a contact, please send an email to [mbdyn@aero.polimi.it](mailto:mbdyn@aero.polimi.it)).
|
|
|
|
|
|
If you feel to go with the second option (submitting code), please read carefully and follow our [Developers Guidelines](Development/developers-guidelines)
|
|
|
### Google Summer of Code
|
|
|
We have been selected as participating Orgs in the [2015](https://www.mbdyn.org/?News&id=19), [2016](https://www.mbdyn.org/?News&id=28), [2017](https://www.mbdyn.org/?News&id=31), and 2019 [Google Summer of Code (GSoC)](https://summerofcode.withgoogle.com). You can find more information in the [dedicated Wiki page](https://public.gitlab.polimi.it/Pub/mbdyn/wikis/Google-Summer-of-Code/GSoC-and-MBDyn) if you're interested in participating to the GSoC with us.
|
|
|
We have been selected as participating Orgs in the [2015](https://www.mbdyn.org/?News&id=19), [2016](https://www.mbdyn.org/?News&id=28), [2017](https://www.mbdyn.org/?News&id=31), and 2019 [Google Summer of Code (GSoC)](https://summerofcode.withgoogle.com). You can find more information in the [dedicated Wiki page](https://public.gitlab.polimi.it/DAER/mbdyn/wikis/Google-Summer-of-Code/GSoC-and-MBDyn) if you're interested in participating to the GSoC with us.
|
|
|
|
|
|
### Some Frequently Asked Questions
|
|
|
|
|
|
#### Where can I find the developers' manual?
|
|
|
The short answer is: __there is no developers' manual__, sorry. A more detailed answer is: it is being authored; a draft copy is distributed within code in [`manual/tecman`](https://public.gitlab.polimi.it/Pub/mbdyn/tree/master/manual/tecman), but it's far from complete and in a very preliminary status. Essentially, developers committed themselves to writing some technical documentation for each new feature that is added to the code, while features already implemented will get documented whenever they need review for whatever reason. Eventually, this document will become complete enough to be called "developers' manual".
|
|
|
The short answer is: __there is no developers' manual__, sorry. A more detailed answer is: it is being authored; a draft copy is distributed within code in [`manual/tecman`](https://public.gitlab.polimi.it/DAER/mbdyn/tree/master/manual/tecman), but it's far from complete and in a very preliminary status. Essentially, developers committed themselves to writing some technical documentation for each new feature that is added to the code, while features already implemented will get documented whenever they need review for whatever reason. Eventually, this document will become complete enough to be called "developers' manual".
|
|
|
|
|
|
#### How to Report a Bug?
|
|
|
The preferred method, since MBDyn moved to Gitlab, is to open an [Issue](https://public.gitlab.polimi.it/Pub/mbdyn/issues). Doing so will provide for better bug tracking and task assignments. Please make sure your request for help or bug report is well formulated. See Simon Tatham's ["How to Report Bugs Effectively"](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) or R. Clint Whaley's ["Why are you such a jerk when answering user questions? AKA: how can I help you feel good about providing me with support?"](http://math-atlas.sourceforge.net/faq.html#utone) for effective discussion of how help requests and bug reports should and SHOULD NOT be formulated. Many thanks to Simon and Clint for spelling out so clearly what we believe often are every free software developer's contrasting feelings with users. In general, before you post a request for help or report a bug, you should first:
|
|
|
The preferred method, since MBDyn moved to Gitlab, is to open an [Issue](https://public.gitlab.polimi.it/DAER/mbdyn/issues). Doing so will provide for better bug tracking and task assignments. Please make sure your request for help or bug report is well formulated. See Simon Tatham's ["How to Report Bugs Effectively"](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) or R. Clint Whaley's ["Why are you such a jerk when answering user questions? AKA: how can I help you feel good about providing me with support?"](http://math-atlas.sourceforge.net/faq.html#utone) for effective discussion of how help requests and bug reports should and SHOULD NOT be formulated. Many thanks to Simon and Clint for spelling out so clearly what we believe often are every free software developer's contrasting feelings with users. In general, before you post a request for help or report a bug, you should first:
|
|
|
- read the most appropriate documentation, including the [FAQs](https://www.mbdyn.org/?Documentation___Official_Documentation___FAQ);
|
|
|
- search the MBDyn users mailing list [archives](https://lists.mbdyn.org/pipermail/mbdyn-users/): someone might have already addressed the same issue, and the answer could be already there;
|
|
|
- post your request, following the previously mentioned indications.
|
... | ... | @@ -45,8 +45,8 @@ This function is invoked when the module is loaded. Any optional args that follo |
|
|
|
|
|
The purpose of this function is usually to register some piece of code that may be used later. A typical use is to register the code that parses a user-defined drive caller, constitutive law, or even an element. Even fancier features can be augmented using run-time loadable modules.
|
|
|
|
|
|
Several examples of user-defined drive callers, constitutive laws, and elements are provided in subfolders of the [`modules/`](https://public.gitlab.polimi.it/Pub/mbdyn/tree/master/modules) folder.
|
|
|
Several examples of user-defined drive callers, constitutive laws, and elements are provided in subfolders of the [`modules/`](https://public.gitlab.polimi.it/DAER/mbdyn/tree/master/modules) folder.
|
|
|
|
|
|
f you need something fancy, that cannot be directly obtained using the built-in library of entities, or you want to develop something that you don't want to share with other users (remember that the whole code is [GPL](https://public.gitlab.polimi.it/Pub/mbdyn/blob/master/LICENSE)), you should consider implementing it using a run-time loadable module.
|
|
|
f you need something fancy, that cannot be directly obtained using the built-in library of entities, or you want to develop something that you don't want to share with other users (remember that the whole code is [GPL](https://public.gitlab.polimi.it/DAER/mbdyn/blob/master/LICENSE)), you should consider implementing it using a run-time loadable module.
|
|
|
|
|
|
Have a look at subfolders of the [`modules/`](https://public.gitlab.polimi.it/Pub/mbdyn/tree/master/modules) folder, starting from those that are closer to what you want to implement; try to understand how things work, and make sure that you follow [these instructions](https://www.mbdyn.org/?Documentation___Official_Documentation___FAQ#HOW_CAN_I_BUILD_RUN_TIME_LOADABLE_MODULES) when building MBDyn. |
|
|
\ No newline at end of file |
|
|
Have a look at subfolders of the [`modules/`](https://public.gitlab.polimi.it/DAER/mbdyn/tree/master/modules) folder, starting from those that are closer to what you want to implement; try to understand how things work, and make sure that you follow [these instructions](https://www.mbdyn.org/?Documentation___Official_Documentation___FAQ#HOW_CAN_I_BUILD_RUN_TIME_LOADABLE_MODULES) when building MBDyn. |
|
|
\ No newline at end of file |