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

add setup instructions to each tutorial #1105

Open
isaacsas opened this issue Nov 1, 2024 · 2 comments
Open

add setup instructions to each tutorial #1105

isaacsas opened this issue Nov 1, 2024 · 2 comments

Comments

@isaacsas
Copy link
Member

isaacsas commented Nov 1, 2024

We should consider adding a new starting section to each tutorial that shows how to install the needed packages in a clean environment. This would make them more self-contained for users.

@TorkelE
Copy link
Member

TorkelE commented Nov 16, 2024

You mean having a

using Pkg
Pkg.activate(".")
Pkg.add("Catalyst")
Pkg.add("BifurcationKit")
Pkg.add("Plots")

a the beginning.

Some tutorials are already rather long (mostly my fault), so a bit reluctant to expand them further with something that is fairly straightforward. Although I could see it being convenient in some cases. Maybe make it standard to put it at the end (although that ruins the convenience factor and is only useful when people realise that is standard). If we could make a collapsed by expandable section at the top of the tutorial with a title "Tutorial environment set-up" or similar, that would probably be ideal.

@isaacsas
Copy link
Member Author

People can just skip the section, but this way they can cut and paste code to run the full tutorial.

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

No branches or pull requests

2 participants