Add new example Jupyter notebooks / edit old ones #626
Open
Description
🐞 Problem
We need new example notebooks or edits to older notebooks to highlight the feature additions and API changes that EinsteinPy has seen over the years. Recently, two PRs added features that could use a notebook demonstrating them. This issue will track multiple features of EinsteinPy that should be properly documented.
- PR Add ability to pass custom metrics to geodesic code. #625 added support for custom metrics functions, outside of electro-vacuum (EV) solutions. We need one or two examples showcasing this (preferably with a non-EV metric).
- PR Addresses #610 - geodesic plotting #612 (issue [FR] Improvements to plotting geodesics #610) improved scaling in geodesic plots. Most of the related example notebook were updated (See discussion in Addresses #610 - geodesic plotting #612), but one had to be left out at the time due to merge conflicts. It can be edited now --- Addresses #626 #643 addressed this.
- More to be added
If you are interested in contributing towards this issue, please do not hesitate to ask for clarifications.
📋 Steps to solve the problem
If you are a new contributor, see this: https://docs.einsteinpy.org/en/latest/dev_guide.html.
- Comment below about what you've started working on.
- Add, commit, push your changes.
- Submit a pull request.
- Add this in the comments:
Addresses #<put issue number here>
if you are partially fixing the issue.Fixes #<put issue number here>
if you are completely fixing the issue.
- Ask for a review in comments section of pull request.
- Celebrate your contribution to this project 🎉.