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

Update Getting Started notebooks #1079

Closed
brosaplanella opened this issue Jun 24, 2020 · 3 comments · Fixed by #1083
Closed

Update Getting Started notebooks #1079

brosaplanella opened this issue Jun 24, 2020 · 3 comments · Fixed by #1083
Assignees

Comments

@brosaplanella
Copy link
Member

Summary
Now that Google Colab compatibility is about to go live it would be nice to create an introductory set of notebooks in the website (Getting Started) section which would launch directly in Colab. Might be a good time to think if we want to update/extend the Getting Started notebooks from the experience we got in the workshops.

Motivation
Set up a very user-friendly set of notebooks to lower the entry barrier to PyBaMM.

@brosaplanella
Copy link
Member Author

Here is a possible structure for the notebooks:

  1. How to run a simulation: basically you define a model, a simulation and run it (the basic stuff, kind of "Hello world!").
  2. Compare models: again, very few lines but we are introducing the three standard models.
  3. Basic plotting: it also helps introducing the variables so we don't have to do it later.
  4. Change parameters: in the same script.
  5. Run experiments: quite descriptive.
  6. Advanced model features: model options, access variables, store outputs...
  7. Advanced solver features: change mesh resolution and solver tolerance.

@tlestang
Copy link
Contributor

tlestang commented Jun 26, 2020

I agree that having some ready-to-try examples on the website would do a lot of good.
Other than notebooks, the new kid in the block is streamlit.io which could be useful to showcases some potential use cases of pybamm

@brosaplanella
Copy link
Member Author

That looks really cool! Might be useful in the future to write some scripts with some data analysis features. @TomTranter would that be helpful for the GUI?

@brosaplanella brosaplanella changed the title Website Getting Started notebooks Update Getting Started notebooks Jun 27, 2020
brosaplanella added a commit to brosaplanella/PyBaMM that referenced this issue Jun 28, 2020
brosaplanella added a commit to brosaplanella/PyBaMM that referenced this issue Jun 28, 2020
@brosaplanella brosaplanella self-assigned this Jun 28, 2020
brosaplanella added a commit to brosaplanella/PyBaMM that referenced this issue Jun 29, 2020
valentinsulzer pushed a commit that referenced this issue Jun 30, 2020
valentinsulzer pushed a commit that referenced this issue Jun 30, 2020
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 a pull request may close this issue.

2 participants