TERPSICHORE #1046
TERPSICHORE #1046
Conversation
…lly-allocated resolution input variables
…ompile for resolution changes)
…longer output during TERPS runs
ddudt
added
interface
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| This guide begins with a simple example of how to use a custom function with the | ||
| ``ExternalObjective``. It then uses the ``TERPSICHORE`` objective as a more realistic | ||
| example, which can be used as a template for wrapping other codes. Finally, an example | ||
| script is shown for how to run the TERPSICHORE optimization with multiprocessing. |
There was a problem hiding this comment.
add a note that one must obtain the TERPSICHORE source themselves and that DESC does not have the code.
There was a problem hiding this comment.
either add note here or later in this doc
|
Should there be a test tto check if the interface works? Maybe have a dummy function instead of the actual TERPSICHORE solver? |
desc/experimental/_terpsichore.py
Outdated
| @@ -707,7 +707,7 @@ class TERPSICHORE(ExternalObjective): | |||
| plasma. If TERPSICHORE fails to run, try decreasing this parameter. Default = 2. | |||
| deltaJp : float, optional | |||
| Resonance detuning parameter to resolve parallel current density singularities. | |||
| Default = 0.5. | |||
There was a problem hiding this comment.
is there any intuition to be gained from understanding this default? like why did you lower it?
There was a problem hiding this comment.
TERPSICHORE documentation recommends a value in the range 1E-4 to 4E-2, I just accidentally had the default way too high.
The inputs awall and deltaJp both artificially stabilize the plasma but make the numerics better, so typically you need to do a convergence scan in both parameters and the "best" value is problem dependent.
| -------------------- | ||
|
|
||
| The ``ExternalObjective`` class allows external codes to be used within a DESC | ||
| optimization. This takes a user-supplied function that does not need not be JAX |
There was a problem hiding this comment.
| optimization. This takes a user-supplied function that does not need not be JAX | |
| optimization. This takes a user-supplied function that does not need to be JAX |
| language besides Python, or cannot be rewritten with JAX for some other reason. If the | ||
| user function can be made JAX transformable, it is recommended to use the | ||
| ``ObjectiveFromUser`` class instead. | ||
|
|
There was a problem hiding this comment.
Might be good to restate desc/experimental/README here
| code TERPSICHORE, which is written in FORTRAN. It summarizes how the external function | ||
| was written to call TERPSICHORE from DESC, and can be used as a template for wrapping | ||
| other codes. The code shown here is abbreviated and slightly modified for brevity, but | ||
| the full source code can be found in ``desc/experimental/_terpsichore.py``. |
There was a problem hiding this comment.
Agree with Dario, this sentence sounds like we have the source code of TERPSICHORE (or this could be my ignorance)
| @@ -82,6 +80,7 @@ | |||
| dev_guide/notebooks/grid.ipynb | |||
| dev_guide/adding_compute_funs.rst | |||
| dev_guide/adding_objectives.rst | |||
| dev_guide/external_objectives.rst | |||
There was a problem hiding this comment.
| dev_guide/external_objectives.rst | |
| external_objectives.rst |
or move it to dev_guide/
Creates an abstract base class for wrapping external codes with finite differences, like GX, TERPSICHORE, etc. TODO: - [x] vectorize - [x] reverse mode gradient (hard-coded to be forward mode, because using forward finite difference) - [x] tests - [x] tutorial (will be added by #1046)
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1046 +/- ##
==========================================
- Coverage 95.70% 94.32% -1.39%
==========================================
Files 101 103 +2
Lines 26284 26669 +385
==========================================
Hits 25155 25155
- Misses 1129 1514 +385
|
New objective function to wrap the TERPSICHORE stability code