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

Some documentation could do with a quick update #35

Closed
Tracked by #36
Cadair opened this issue May 1, 2024 · 4 comments · Fixed by #45
Closed
Tracked by #36

Some documentation could do with a quick update #35

Cadair opened this issue May 1, 2024 · 4 comments · Fixed by #45
Milestone

Comments

@Cadair
Copy link
Member

Cadair commented May 1, 2024

https://docs.sunpy.org/projects/sunkit-magex/en/latest/performance.html this still references "FORTRAN" in a few places.

@STBadman
Copy link
Contributor

STBadman commented May 2, 2024

So this doc references sunkit-magex.pfss.tracing.FortranTracer which still exists. My understanding is if you have streamtracer <v1.2.0 then using this class will use Fortran, but otherwise FotranTracer in fact uses RUST - is that true?

If so (if the version affects the tracing backend language) - then should we rename the class PerfomanceTracer or something similar? or if Fortran support is going away entirely, rename it RustTracer ?

@jgieseler
Copy link
Member

So this doc references sunkit-magex.pfss.tracing.FortranTracer which still exists. My understanding is if you have streamtracer <v1.2.0 then using this class will use Fortran, but otherwise FotranTracer in fact uses RUST - is that true?

That's also my understanding.

If so (if the version affects the tracing backend language) - then should we rename the class PerfomanceTracer or something similar? or if Fortran support is going away entirely, rename it RustTracer ?

That's why I added "Automatically pick working/best Tracer" #37 😅 But yeah, I think the idea is to get rid of Fortran totally, and then I would give it a generic name.

@Cadair
Copy link
Member Author

Cadair commented May 7, 2024

The references to fortran outside of the link to the class should at least be removed. This issue was also more general about just giving the docs a quick read through to make sure they are up to date.

@samaloney
Copy link

I guess the example gallery directory using_pfsspy should be renamed to using_sunkit_magex?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants