Skip to content

Commit 9e3d3be

Browse files
committed
Update documentation and requirements; remove old examples and enhance installation instructions
1 parent ba38d63 commit 9e3d3be

13 files changed

+9
-1563
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
- [Acknowledgments](#acknowledgments)
3737

3838
## Overview
39-
ESSOS is an open-source project in Python that uses JAX to optimize stellarator coils. Optimization can be applied to several objectives, such as alpha particle confinement, plasma boundaries and magnetic field equilibria. It leverages automatic differentiation and efficient numerical methods to streamline optimization efforts, creating a specialized and fast numerical tool for optimizing force-free stellarator equilibria. It can be imported in a Python script using the **essos** package, or run directly in the command line as `essos`. To install it, use
39+
ESSOS is an open-source project in Python that uses JAX to optimize stellarator coils. Optimization can be applied to several objectives, such as alpha particle confinement, plasma boundaries and magnetic field equilibria. It leverages automatic differentiation and efficient numerical methods to streamline optimization efforts, creating a specialized and fast numerical tool for optimizing force-free stellarator equilibria. It is parallelized using JAX's sharding tools. It can be imported in a Python script using the **essos** package, or run directly in the command line as `essos`. To install it, use
4040

4141
```sh
4242
pip install essos

docs/getting_started.rst

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,21 @@ Installation
77
------------
88

99
To use ESSOS, there is no need to install it.
10-
You can simply clone the repository and install the dependencies using the following command:
10+
You can simply clone the repository and install it using the following command:
1111

1212
.. code-block:: console
1313
1414
$ git clone https://github.com/uwplasma/ESSOS.git
1515
$ cd ESSOS
16-
$ pip install -r requirements.txt
17-
18-
these are
19-
20-
- jax
21-
- jax_tqdm
22-
- matplotlib
16+
$ pip install .
2317
2418
Run an example
2519
--------------
2620

27-
To run the main example, use the following command:
21+
To run the one of the examples, use the following command:
2822

2923
.. code-block:: console
3024
31-
python main.py
25+
python examples/trace_fieldlines_coils.py
3226
3327
More examples are in the `examples` folder.

docs/requirements.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
jax
2-
jax_tqdm
2+
jaxlib
3+
diffrax
4+
scipy
5+
netcdf4
36
matplotlib
47
sphinx
58
sphinx-autoapi

examples_old/finitedifference_vs_autodiff.py

Lines changed: 0 additions & 146 deletions
This file was deleted.

0 commit comments

Comments
 (0)