Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated doc and example action #155

Merged
merged 14 commits into from
Sep 19, 2024
Merged

updated doc and example action #155

merged 14 commits into from
Sep 19, 2024

Conversation

0815Creeper
Copy link
Contributor

tested and functional, merge #154 immediately before merging this

- [__Scientific Machine Learning using Functional Mock-up Units__](../pluto-src/SciMLUsingFMUs/SciMLUsingFMUs.html): Workshop at JuliaCon 2024 (Eindhoven University, Netherlands)
[__Pluto workshops__](https://thummeto.github.io/FMI.jl/dev/examples/workshops/): [Pluto](https://plutojl.org/) based notebooks, that can easily be executed on your own Pluto-Setup.
- [__Scientific Machine Learning using Functional Mock-up Units__](https://thummeto.github.io/FMI.jl/dev/examples/pluto-src/SciMLUsingFMUs/SciMLUsingFMUs.html): Workshop at JuliaCon 2024 (Eindhoven University, Netherlands)
- [__Hands-on: Hybrid Modeling using FMI__](https://thummeto.github.io/FMI.jl/dev/examples/pluto-src/HybridModelingUsingFMI/HybridModelingUsingFMI.html): Workshop at MODPROD 2024 (Linköping University, Sweden)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Hands-on: Hybrid Modeling using FMI" should stay in the "archived" section :-)

Copy link
Contributor Author

@0815Creeper 0815Creeper Sep 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in that case, we should consider an "archived" flag/folder/... for examples, that are deprecated: they should then also no longer be included in the example CI... (maybe we could put the built and exported version next to pluto-src and jupyter-src on the examples branch into deprecated, then they are not in danger of beeing accidentally cleaned up and do not have to be maintained to stay runable ;) we could still include them in another part of the CI, that is not critical to the actions success -similar to a try-catch- and output a badge for each deprecated example, that indicates if it is still runable and throw a action-warning otherwise)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for now, your request is implemented

./*.gif
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this necessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, otherwise juliacon example will not work as it should: if I am not mistaken, *.gif prevents also gifs in subdirectorys from beeing added, but e.g. in juliacon_files we want the gif to exist. ./*.gif prevents stray gifs (that do not follow the naming convention of gif_[number].gif from beeing pushed while residing in the jupyter-src directory instead of the dedicated [example]_files directory)

@0815Creeper
Copy link
Contributor Author

0815Creeper commented Sep 18, 2024

(doc action obviously still fails, as examples are not pushed to branch by PR, but with valid examples, it succeds here: https://github.com/0815Creeper/FMIFlux.jl/actions/runs/10926847702)

@ThummeTo ThummeTo merged commit 65b6ccf into ThummeTo:main Sep 19, 2024
10 of 13 checks passed
@0815Creeper 0815Creeper deleted the main branch September 27, 2024 07:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants