Restructure the CossanObjects tutorial folder

FriesischScott commented 4 years ago

Currently all CossanObjects tutorials live in a single folder under docs/tutorials/CossanObjects. Since there are too many files to easily scan the folder for the required info I suggest to restructure the tutorials in the following way:

|-- +opencossan
|-- docs
    |-- classes
        |-- common
            |-- inputs
                |-- TutorialFunction.m
                |-- TutorialInput.m
                |-- ...
            |-- TutorialModel.m
            |-- ...
        |-- reliablity
            |-- TutorialDesignPoint.m
            |-- ...
        |-- sensitivity
            |-- TutorialMonteCarlo.m
            |-- ...
        |-- ...
    |-- tutorials
        |-- CantileverBeam
        |-- IshigamiFunction
        |-- ...

By leveraging the same structure as the source packages, the tutorials for any class can be quickly found by the user. Less files in each folder is significantly cleaner.

This will also clearly separate the full tutorials from the class/object tutorials.

In addition, this will hopefully allow for a nicer structure if we do figure out a way to generate nice documentation from the tutorials.

Thoughts, @etheban ?

etheban commented 4 years ago

Good idea

Get Outlook for Androidhttps://aka.ms/ghei36

From: Jasper Behrensdorf notifications@github.com Sent: Friday, June 12, 2020 1:21:06 PM To: cossan-working-group/OpenCossan OpenCossan@noreply.github.com Cc: Edoardo Patelli edoardo.patelli@strath.ac.uk; Mention mention@noreply.github.com Subject: [cossan-working-group/OpenCossan] Restructure the CossanObjects tutorial folder (#39)

Currently all CossanObjects tutorials live in a single folder under docs/tutorials/CossanObjects. Since there are too many files to easily scan the folder for the required info I suggest to restructure the tutorials in the following way:

By leveraging the same structure as the source packages, the tutorials for any class can be quickly found by the user. Less files in each folder is significantly cleaner.

This will also clearly separate the full tutorials from the class/object tutorials.

In addition, this will hopefully allow for a nicer structure if we do figure out a way to generate nice documentation from the tutorials.

Thoughts, @ethebanhttps://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fetheban&data=02%7C01%7Cedoardo.patelli%40strath.ac.uk%7C872e6aa3350d4db911c508d80ecb15f1%7C631e0763153347eba5cd0457bee5944e%7C0%7C0%7C637275612689883249&sdata=1srsTVb8WmxuNj8eZGeqCsKbs3uLUwBFei7XURS07Lk%3D&reserved=0 ?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fcossan-working-group%2FOpenCossan%2Fissues%2F39&data=02%7C01%7Cedoardo.patelli%40strath.ac.uk%7C872e6aa3350d4db911c508d80ecb15f1%7C631e0763153347eba5cd0457bee5944e%7C0%7C0%7C637275612689883249&sdata=Pkr5BZUjBljDiIBy6jcjiKZHCfVD1IGmUOfgmoki1Qw%3D&reserved=0, or unsubscribehttps://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FADBXT426IK5O44UMM55XA4TRWIMTFANCNFSM4N4I7VZQ&data=02%7C01%7Cedoardo.patelli%40strath.ac.uk%7C872e6aa3350d4db911c508d80ecb15f1%7C631e0763153347eba5cd0457bee5944e%7C0%7C0%7C637275612689893245&sdata=4%2F%2Ft2wXzxzV8hyF4Ip9VrbFf5Rmj2Ak%2FfrHqFaEBYpI%3D&reserved=0.

FriesischScott commented 4 years ago

Coolio, I'll see if I can get a pull request together. While I do that I will also see if we can turn more of the tutorials into integration tests.

cossan-working-group / OpenCossan

Restructure the CossanObjects tutorial folder #39