8000 Add new example Jupyter notebooks / edit old ones · Issue #626 · einsteinpy/einsteinpy · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add new example Jupyter notebooks / edit old ones #626

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

Open
1 of 3 tasks
JeS24 opened this issue Nov 15, 2022 · 13 comments
Open
1 of 3 tasks

Add new example Jupyter notebooks / edit old ones #626

JeS24 opened this issue Nov 15, 2022 · 13 comments
Labels
documentation good first issue Good for newcomers hacktoberfest Hacktoberfest 2023
Milestone

Comments

@JeS24
Copy link
Member
JeS24 commented Nov 15, 2022

🐞 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.

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 🎉.
@JeS24 JeS24 added this to the 0.5.0 milestone Nov 15, 2022
@JeS24 JeS24 mentioned this issue Jan 31, 2023
5 tasks
@Snerdify
Copy link
Snerdify commented Jul 7, 2023

Hey has the issue already assigned or can i take it up? @JeS24

@JeS24 JeS24 pinned this issue Jul 7, 2023
@VigneshRamanathan101
Copy link

Is this issue still open?

@JeS24
Copy link
Member Author
JeS24 commented Jul 22, 2023

@vigneshRamanathan3105 Yes.

@VigneshRamanathan101
Copy link

Is this free to pick up?

@JeS24
Copy link
Member Author
JeS24 commented Jul 22, 2023

@vigneshRamanathan3105 Yeah, it is. This issue will have multiple parts and multiple PRs. So, just make sure to comment here what you've started working on, so that others are in the loop. For example, if you work on an example notebook wrt #625, you can mention that here.

@dxtym
Copy link
dxtym commented Aug 17, 2023

Good day! It's my first try. Just wanted to ask if this issue is still valid.

@JeS24
Copy link
Member Author
JeS24 commented Aug 17, 2023

Good day! It's my first try. Just wanted to ask if this issue is still valid.

Good day. This issue is open for contributions.

@JeS24 JeS24 added the hacktoberfest Hacktoberfest 2023 label Sep 24, 2023
@jjmcinto
Copy link
Contributor

I updated some plots in Visualizing Precession in Schwarzschild Spacetime.ipynb to demonstrate title and colour selection functionality.

I will attempt to send a pull request shortly.

@jjmcinto
Copy link
Contributor
jjmcinto commented Sep 27, 2023

Nope, that did not work. I need authorization to push:

$ git commit -m "Addresses #610"
[main 4209569] Addresses #610
2 files changed, 98949 insertions(+), 98932 deletions(-)
rewrite docs/source/examples/Visualizing Precession in Schwarzschild Spacetime.ipynb (71%)

$ git push
remote: Permission to einsteinpy/einsteinpy.git denied to jjmcinto.
fatal: unable to access 'https://github.com/einsteinpy/einsteinpy.git/': The requested URL returned error: 403

So, who can I talk to about adding my changes to the documentation?

@JeS24
Copy link
Member Author
JeS24 commented Sep 27, 2023

@jjmcinto You need to fork this repo first. Then, commit & push changes to that fork and open a PR. See: https://docs.github.com/en/get-started/quickstart/contributing-to-projects or https://docs.einsteinpy.org/en/latest/dev_guide.html for EinsteinPy-specific development details.

@JeS24 JeS24 mentioned this issue Oct 10, 2023
JeS24 pushed a commit that referenced this issue Oct 10, 2023
Added colours, chart titles, newly added arguments  to demonstrate new functionality in example notebooks for `einsteinpy.plotting.geodesic.*`.
@aSimpson02
Copy link

Hi I would like to have a go at the first issue if thats still available?

@JeS24
Copy link
Member Author
JeS24 commented May 4, 2024

@aSimpson02 Hi. That issue's available. Feel free to contribute.

@mushtaq96
Copy link

Hi @aSimpson02 , did you already finish working on this task?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue Good for newcomers hacktoberfest Hacktoberfest 2023
Projects
None yet
Development

No branches or pull requests

7 participants
0