search

pyro-kinetics / pyrokinetics

Python library to run and analyse gyrokinetics simulations
https://pyrokinetics.readthedocs.io/en/latest/#
GNU Lesser General Public License v3.0
25 stars 6 forks source link

Enhancements/clean documentation #310

Closed arkabokshi closed 7 months ago

arkabokshi commented 8 months ago

A bugfix and removing some legacy code to make the documentation more accessible. This will always remain a WIP, so can be merged at any appropriate point!

codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.78%. Comparing base (1ac38ec) to head (8a75bde).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## unstable #310 +/- ## ========================================= Coverage 84.78% 84.78% ========================================= Files 46 46 Lines 7021 7021 ========================================= Hits 5953 5953 Misses 1068 1068 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

arkabokshi commented 7 months ago

@bpatel2107 Should we merge this into enhancements/imas_v3.4 instead? I can build the GKW documentation on top of this.

bpatel2107 commented 7 months ago

No this is already becoming a massive PR which isn't ideal so separate is fine I think. Just make the GKW relevant docs changes on that