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

Dev guide #353

Draft
wants to merge 49 commits into
base: master
Choose a base branch
from
Draft

Dev guide #353

wants to merge 49 commits into from

Conversation

dpanici
Copy link
Collaborator

@dpanici dpanici commented Dec 14, 2022

Update from April 2023
under docs/dev_guide
readable now (will still improve)

  • compute.rst (Adding new physics quantities)
  • objectives.rst (Adding new objective functions
  • grid.ipynb (Collocation grids)
  • backend.rst (JAX vs Numpy)
  • configuration_equilibrium.rst
  • optimization_objectives_constraints.ipynb
  • transform.ipynb

half done

  • compute.ipynb (will merge with utils)

to do:

  • vmec.ipynb
  • perturbations.ipynb
  • fast fourier stuff on transform.ipynb

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Jan 11, 2023

Codecov Report

Merging #353 (60935d9) into master (a2fe711) will decrease coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #353      +/-   ##
==========================================
- Coverage   94.26%   94.26%   -0.01%     
==========================================
  Files          78       78              
  Lines       18176    18176              
==========================================
- Hits        17134    17133       -1     
- Misses       1042     1043       +1     
Files Changed Coverage Δ
desc/compute/_core.py 100.00% <ø> (ø)
desc/compute/_equil.py 100.00% <ø> (ø)
desc/compute/_field.py 100.00% <ø> (ø)
desc/compute/_geometry.py 81.57% <ø> (ø)
desc/compute/_metric.py 100.00% <ø> (ø)

... and 1 file with indirect coverage changes

@unalmis unalmis self-assigned this Jan 12, 2023
@unalmis unalmis added documentation Add documentation or better warnings etc. theory Requires theory work before coding labels Apr 12, 2023
@YigitElma
Copy link
Collaborator

This is done on #1304

@YigitElma
Copy link
Collaborator

YigitElma commented Oct 20, 2024

@unalmis @dpanici There are some duplicate notebooks on dev_guide and notebooks/dev_guide folders. Are there any differences with those? Can you delete the old one and put the most updated one to the dev_guide/notebooks folder?

Also, what is compute_2.ipynb?

docs/dev_guide/compute.rst Outdated Show resolved Hide resolved
Adding new physics quantities
-----------------------------
=============================
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't neeed to change this one

@dpanici
Copy link
Collaborator Author

dpanici commented Nov 27, 2024

Use master for grid.ipynb as well

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add documentation or better warnings etc. theory Requires theory work before coding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants