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 25 commits into
base: master
Choose a base branch
from
Draft

Dev guide #353

wants to merge 25 commits into from

Conversation

dpanici
Copy link
Collaborator

@dpanici dpanici commented Dec 14, 2022

Update from April 2023 by @unalmis
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
To update elements in ``jax.numpy`` arrays, memory needs to be allocated to create a new array with the updated element.
Similarly, JAX's JIT compilation requires code flow structures such as loops and conditionals to be written in a specific way.

The utility functions in ``desc.backend`` provide a simple interface to perform these operations.
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should add answers to (good) questions like this here:
#854 (comment)
#854 (comment)

unalmis added a commit that referenced this pull request Aug 22, 2024
This PR moves the integration utilities to their own subfolder so that
they are visible to users. We have decided not to include in public API,
because that's for optimization stuff.

- [x] Increase visibility of integration utilities.
- [x] Resolve #723 by adding link to tutorial in docstring of
`surface_integrals.py`.
- [x] Update `grid.py` developer guide.
- Cherry picked from #353 with the new section from #1101 that
emphasizes poloidal midplane symmetry is not stellarator symmetry.
Removed section on custom grids.
@unalmis
Copy link
Collaborator

unalmis commented Aug 22, 2024

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.

2 participants