Skip to content

Add example notebooks#23

Merged
gjbex merged 9 commits into
masterfrom
development
Nov 22, 2024
Merged

Add example notebooks#23
gjbex merged 9 commits into
masterfrom
development

Conversation

@gjbex

@gjbex gjbex commented Nov 22, 2024

Copy link
Copy Markdown
Owner

Summary by Sourcery

Introduce a set of example Jupyter notebooks demonstrating scientific simulations and visualizations, and update the README.md to reflect these additions.

New Features:

  • Add new Jupyter notebooks for various scientific simulations and visualizations, including examples for cellular automata, diffusion-limited aggregation, Ising model, Lennard-Jones potential, and a prison guard visibility simulation.

Enhancements:

  • Update the README.md file to include descriptions and links to the newly added Jupyter notebooks, providing users with an overview of the available examples and their purposes.

@sourcery-ai

sourcery-ai Bot commented Nov 22, 2024

Copy link
Copy Markdown

Reviewer's Guide by Sourcery

This PR adds several example Jupyter notebooks demonstrating various scientific computing concepts using Python. The notebooks cover topics like cellular automata, diffusion-limited aggregation, the Ising model, Lennard-Jones potentials, and a prison guard visibility problem.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added new example notebooks to demonstrate scientific computing concepts
  • Added cellular_automata.ipynb for matplotlib visualization
  • Added diffusion_limited_aggregation.ipynb using numpy and matplotlib
  • Added ising_model.ipynb demonstrating numpy and dependency injection
  • Added lennard_jones.ipynb showing molecular dynamics concepts
  • Added prison_guard.ipynb for geometric calculations
source-code/README.md
source-code/cellular_automata.ipynb
source-code/diffusion_limited_aggregation.ipynb
source-code/ising_model.ipynb
source-code/lennard_jones.ipynb
source-code/prison_guard.ipynb
Removed outdated particles.ipynb notebook
  • Deleted particles.ipynb which is being replaced by more focused examples
source-code/particles.ipynb

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@gjbex
gjbex merged commit b547860 into master Nov 22, 2024

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey @gjbex - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread source-code/README.md
a high-pass filter.
and writing of a WAV file, computing the amplitude spectrum using FFT,
applying a high-pass filter.
* [`boekh`](bokeh): illustrations of how to create plots using bokeh, including

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

issue (typo): There appears to be a typo in the directory name - 'boekh' should be 'bokeh'

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.

1 participant