Skip to content

Commit

Permalink
change title versions
Browse files Browse the repository at this point in the history
  • Loading branch information
YigitElma committed Oct 21, 2024
1 parent c986268 commit 4ffc092
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 7 deletions.
3 changes: 2 additions & 1 deletion docs/dev_guide/adding_compute_funs.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
=============================
Adding new physics quantities
-----------------------------
=============================

.. role:: console(code)
:language: console
Expand Down
3 changes: 2 additions & 1 deletion docs/dev_guide/adding_objectives.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
==============================
Adding new objective functions
------------------------------
==============================

This guide walks through creating a new objective to optimize using Quasi-symmetry as
an example. The primary methods needed for a new objective are ``__init__``, ``build``,
Expand Down
3 changes: 2 additions & 1 deletion docs/dev_guide/adding_optimizers.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.. _adding-optimizers:

=====================
Adding new optimizers
----------------------
=====================

This guide walks through adding an interface to a new optimizer. As an example, we will
write an interface to the popular open source ``ipopt`` interior point method.
Expand Down
3 changes: 2 additions & 1 deletion docs/dev_guide/backend.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
=======
Backend
-------
=======


DESC uses JAX for faster compile times, automatic differentiation, and other scientific computing tools.
Expand Down
3 changes: 2 additions & 1 deletion docs/dev_guide/compute.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
=============================
Adding new physics quantities
-----------------------------
=============================


All calculation of physics quantities takes place in ``desc.compute``
Expand Down
3 changes: 2 additions & 1 deletion docs/dev_guide/configuration_equilibrium.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
===================================
Configuration.py and Equilibrium.py
-----------------------------------
===================================

To construct an equilibrium, the relevant parameters that decide the plasma state need to created and passed into the constructor of the ``Equilibrium`` class.
See ``Initializing an Equilibrium`` for a walk-through of this process.
Expand Down
3 changes: 2 additions & 1 deletion docs/dev_guide/objectives.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
==============================
Adding new objective functions
------------------------------
==============================

This guide walks through creating a new objective to optimize using Quasi-symmetry as
an example. The primary methods needed for a new objective are ``__init__``, ``build``,
Expand Down

0 comments on commit 4ffc092

Please sign in to comment.