search

spedas / pyspedas

Python-based Space Physics Environment Data Analysis Software
https://pyspedas.readthedocs.io/
MIT License
143 stars 58 forks source link

Master list for tplot documentation updates #783

Closed jameswilburlewis closed 1 month ago

jameswilburlewis commented 4 months ago

Here is the next batch of routines that need their docstrings checked and updated. All parameters should be documented, with any default values called out, and any "multiple-choice" type parameters listed out in the docstrings (if practical). For the ones that already have examples in the docstrings, please check to ensure that they still work; if not, please add an example. Type hints would also be nice...most of them should be fairly obvious.

I'll start with a few assignments -- as you finish a group, please check them off here, then claim a few more to work on by editing in your name on the routines you'll be working on next.

Pytplot/tplot_math:

Pytplot:

pyspedas/analysis:

pyspedas/utilities

clrussell90404 commented 4 months ago

Hi Jim,

My version of pyspedas on pycharm only has pyspedas project files. How do I access Pytplot/tplot_math using pycharm and girhub?

Thanks,

Cindy

From: Jim Lewis @.> Sent: Friday, March 1, 2024 4:49 PM To: spedas/pyspedas @.> Cc: Russell, Cindy @.>; Assign @.> Subject: [spedas/pyspedas] Master list for tplot documentation updates (Issue #783)

Here is the next batch of routines that need their docstrings checked and updated. All parameters should be documented, with any default values called out, and any "multiple-choice" type parameters listed out in the docstrings (if practical). For the ones that already have examples in the docstrings, please check to ensure that they still work; if not, please add an example. Type hints would also be nice...most of them should be fairly obvious.

I'll start with a few assignments -- as you finish a group, please check them off here, then claim a few more to work on by editing in your name on the routines you'll be working on next.

Pytplot/tplot_math:

Pytplot:

pyspedas/analysis:

pyspedas/utilities

— Reply to this email directly, view it on GitHubhttps://github.com/spedas/pyspedas/issues/783, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A5NNFATJMQZQD3AO2FTZXDDYWEHYFAVCNFSM6AAAAABECSM5ICVHI2DSMVQWIX3LMV43ASLTON2WKOZSGE3DIMZXGMYTAOA. You are receiving this because you were assigned.

jameswilburlewis commented 4 months ago

The PyTplot code is in a different repository, under MAVENSDC. I've just sent out invitations to all of you who aren't already collaborators on the PyTplot repo, so once you accept the invite, you should be able to push your changes directly instead of doing pull requests.

I would recommend setting PyTplot up as a separate Pycharm project, with its own virtual environment. You can do that by closing any open Pycharm projects -- when you close the last one, it should take you to an "open project" dialog with "Get from VCS" as one of the options. Click on that, then on the next panel there should be an option for Github. Click on that -- it will probably populate the right pane with the SPEDAS repositories, but MAVENSDC/PyTplot may or may not be there. If not, type it into the search bar at the top, and it should show up in the list underneath where you can select it. Then click the "Clone" button to start setting up the new project, the same way you did for pyspedas.

Once the environment is set up, there's a very important step -- be sure you're working in the "matplotlib-backend" branch! Click on "Git->Branches...", and under the "remote branches" list, click on "matplotlib-backend', then "Checkout" from the options it gives. That should switch your local copy to the correct branch.

For testing purposes, you may want to install pyspedas in your PyTplot environment with "pip install pyspedas" using the PyCharm terminal window.

nickssl commented 4 months ago

I removed the file tplot_math/examples.py.

This file contained some examples for an early version of pytplot, that are not useful any more. Most examples either used pytplot.data_quants directly (which should be avoided) or did not work because they called functions that do not exist anymore.

xandrd commented 3 months ago

I marked some of my tasks as (Sasha / [assign others]). If I will have time, I will take the tasks back changing them to just (Sasha), if they will remained unassigned.