| Name | aqsc JSON |
| Version |
0.1.9
JSON |
| download |
| home_page | |
| Summary | Constructs QS stellarator equilibrium to all orders. |
| upload_time | 2024-02-08 15:44:11 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyAQSC
This code constructs globally quasi-symmetric stellarator equilibria with
anisotropic pressure near axis expansion to any order.
## Documentations
[Click here to read pyAQSC documentations.](https://pyaqsc.readthedocs.io/en/latest/)
## Dependencies
The python codes requires Numpy, Matplotlib, and JAX. To install a JAX version
matching your hardware, see the official
[JAX installation guide](https://jax.readthedocs.io/en/latest/installation.html).
The Maxima notebooks requires wxMaxima to view. The notebooks are not required to
run the main code, but contains source expressions much of code is parsed from.
## Repository structure and files
```
├── README.MD
├── test_data_eduardo/ -> Known leading order terms for some equilibria.
├── docs/ -> Documentations
├── dist/ -> Built python package
├── examples/ -> Jupyter notebooks with use cases for the code.
├── magnetic_recursion_relations/ -> Maxima notebooks for iterating the
│ │ magnetic equations
│ ├── <Quantity name>.wxmx -> Maxima notebooks for the recursion relations.
│ └── general_formulae/ -> Maxima notebooks directly expanding
│ the governing equations. for reference only.
├── MHD_recursion_relations/ -> Maxima notebooks for iterating the
│ │ magnetic and force balance equations
│ ├── looped.lisp -> Variables associated with the "looped equation"[2].
│ │ see Looped.wxmx and Looped study simplified.wxmx
│ │ see for details.
│ ├── <Quantity name>.wxmx -> ...
│ └── general_formulae/ -> ...
│
├── maxima_scripts/ -> Maxima libraries
│ ├── near_axis_expansion.mac -> Stores the governing equations and
│ │ variable dependencies.
│ ├── power_mode_matching/ -> A standalone, symbolic infinite/finite
│ │ │ power/Fourier series order/mode matcher.
│ │ ├── power_matching.mac -> The power series order matcher
│ │ └── trig_fourier_or... .mac -> The Fourier series mode matcher
│ ├── python_parser.mac -> A code translating maxima summations
│ │ to python codes. Works with
│ │ python_source/math_utilities.py
│ ├── sbatch_maxima.mac -> A code generating slurm jobscripts for
│ │ evaluating maxima expressions in parallel
│ └── test_cases/ -> Test cases for Maxima scripts.
└── src/aqsc/ -> Python source for the main code.
├── __init__.py
├── config.py -> Configurations. (numerical, run-time, ...)
├── equilibrium.py -> Contains the Equilibrium object that manages
│ the iteration of an equilibrium represented
│ by near axis expansion. Also contains wrappers
│ for methods in parsed/ and MHD_parsed/.
├── chiphiepsfunc.py -> A list-like data structure for storing power coeffs.
├── chiphifunc.py -> A data structure representing f(chi,phi)
│ as chi Fourier coeffs on phi grids, implementation
│ for operators, and some solvers/utilities.
├── chiphifunc_test_suite.py -> Useful functions for testing and plotting.
├── math_utilities.py -> More numerical operations needed to run
│ python methods in python_source/parsed/
├── looped_solver.py -> Solver for the "looped equations" [2, 3]
├── parsed/ -> Parsed expressions for the magnetic-only
│ recursion relations [1]. All generated by notebooks
├── looped_coefs/ -> Coefficients in the looped equations.
└── MHD_parsed/ -> Parsed expressions for the full (magnetic and
force balance) recursion relations [2]. All
generated by notebooks in MHD_recursion_relations/
```
## References
1. [Weakly Quasisymmetric Near-Axis Solutions to all Orders](https://doi.org/10.1063/5.0076583)
2. [Solving the problem of overdetermination of quasisymmetric equilibrium solutions by near-axis expansions. I. Generalized force balance](https://doi.org/10.1063/5.0027574)
3. [Solving the problem of overdetermination of quasisymmetric equilibrium solutions by near-axis expansions. II. Circular axis stellarator solutions](https://aip.scitation.org/doi/10.1063/5.0027575)
4. [pyQSC](https://github.com/landreman/pyQSC)
Raw data
{
"_id": null,
"home_page": "",
"name": "aqsc",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Lanke Fu <ffu@pppl.gov>",
"download_url": "https://files.pythonhosted.org/packages/9c/f7/5c55e581aa09539a252a52121628ccd6ab41b81b5cabea37b1a5f62ce10b/aqsc-0.1.9.tar.gz",
"platform": null,
"description": "# pyAQSC\nThis code constructs globally quasi-symmetric stellarator equilibria with\nanisotropic pressure near axis expansion to any order.\n\n## Documentations\n[Click here to read pyAQSC documentations.](https://pyaqsc.readthedocs.io/en/latest/)\n\n## Dependencies\nThe python codes requires Numpy, Matplotlib, and JAX. To install a JAX version \nmatching your hardware, see the official \n[JAX installation guide](https://jax.readthedocs.io/en/latest/installation.html).\n\nThe Maxima notebooks requires wxMaxima to view. The notebooks are not required to\nrun the main code, but contains source expressions much of code is parsed from.\n\n## Repository structure and files\n```\n\u251c\u2500\u2500 README.MD\n\u251c\u2500\u2500 test_data_eduardo/ -> Known leading order terms for some equilibria.\n\u251c\u2500\u2500 docs/ -> Documentations\n\u251c\u2500\u2500 dist/ -> Built python package\n\u251c\u2500\u2500 examples/ -> Jupyter notebooks with use cases for the code.\n\u251c\u2500\u2500 magnetic_recursion_relations/ -> Maxima notebooks for iterating the\n\u2502 \u2502 magnetic equations\n\u2502 \u251c\u2500\u2500 <Quantity name>.wxmx -> Maxima notebooks for the recursion relations.\n\u2502 \u2514\u2500\u2500 general_formulae/ -> Maxima notebooks directly expanding\n\u2502 the governing equations. for reference only.\n\u251c\u2500\u2500 MHD_recursion_relations/ -> Maxima notebooks for iterating the\n\u2502 \u2502 magnetic and force balance equations\n\u2502 \u251c\u2500\u2500 looped.lisp -> Variables associated with the \"looped equation\"[2].\n\u2502 \u2502 see Looped.wxmx and Looped study simplified.wxmx\n\u2502 \u2502 see for details.\n\u2502 \u251c\u2500\u2500 <Quantity name>.wxmx -> ...\n\u2502 \u2514\u2500\u2500 general_formulae/ -> ...\n\u2502 \n\u251c\u2500\u2500 maxima_scripts/ -> Maxima libraries\n\u2502 \u251c\u2500\u2500 near_axis_expansion.mac -> Stores the governing equations and\n\u2502 \u2502 variable dependencies.\n\u2502 \u251c\u2500\u2500 power_mode_matching/ -> A standalone, symbolic infinite/finite\n\u2502 \u2502 \u2502 power/Fourier series order/mode matcher.\n\u2502 \u2502 \u251c\u2500\u2500 power_matching.mac -> The power series order matcher\n\u2502 \u2502 \u2514\u2500\u2500 trig_fourier_or... .mac -> The Fourier series mode matcher\n\u2502 \u251c\u2500\u2500 python_parser.mac -> A code translating maxima summations\n\u2502 \u2502 to python codes. Works with\n\u2502 \u2502 python_source/math_utilities.py\n\u2502 \u251c\u2500\u2500 sbatch_maxima.mac -> A code generating slurm jobscripts for\n\u2502 \u2502 evaluating maxima expressions in parallel\n\u2502 \u2514\u2500\u2500 test_cases/ -> Test cases for Maxima scripts.\n\u2514\u2500\u2500 src/aqsc/ -> Python source for the main code.\n \u251c\u2500\u2500 __init__.py \n \u251c\u2500\u2500 config.py -> Configurations. (numerical, run-time, ...)\n \u251c\u2500\u2500 equilibrium.py -> Contains the Equilibrium object that manages\n \u2502 the iteration of an equilibrium represented\n \u2502 by near axis expansion. Also contains wrappers\n \u2502 for methods in parsed/ and MHD_parsed/.\n \u251c\u2500\u2500 chiphiepsfunc.py -> A list-like data structure for storing power coeffs.\n \u251c\u2500\u2500 chiphifunc.py -> A data structure representing f(chi,phi)\n \u2502 as chi Fourier coeffs on phi grids, implementation\n \u2502 for operators, and some solvers/utilities.\n \u251c\u2500\u2500 chiphifunc_test_suite.py -> Useful functions for testing and plotting.\n \u251c\u2500\u2500 math_utilities.py -> More numerical operations needed to run\n \u2502 python methods in python_source/parsed/\n \u251c\u2500\u2500 looped_solver.py -> Solver for the \"looped equations\" [2, 3]\n \u251c\u2500\u2500 parsed/ -> Parsed expressions for the magnetic-only\n \u2502 recursion relations [1]. All generated by notebooks\n \u251c\u2500\u2500 looped_coefs/ -> Coefficients in the looped equations.\n \u2514\u2500\u2500 MHD_parsed/ -> Parsed expressions for the full (magnetic and\n force balance) recursion relations [2]. All\n generated by notebooks in MHD_recursion_relations/\n\n```\n\n## References\n1. [Weakly Quasisymmetric Near-Axis Solutions to all Orders](https://doi.org/10.1063/5.0076583)\n2. [Solving the problem of overdetermination of quasisymmetric equilibrium solutions by near-axis expansions. I. Generalized force balance](https://doi.org/10.1063/5.0027574)\n3. [Solving the problem of overdetermination of quasisymmetric equilibrium solutions by near-axis expansions. II. Circular axis stellarator solutions](https://aip.scitation.org/doi/10.1063/5.0027575)\n4. [pyQSC](https://github.com/landreman/pyQSC)\n",
"bugtrack_url": null,
"license": "",
"summary": "Constructs QS stellarator equilibrium to all orders.",
"version": "0.1.9",
"project_urls": {
"Homepage": "https://github.com/lankef/pyAQSC"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d2e976b75fd6ff6fdafe1b6e2056312587d3eac3507816d55fb9a61b7383c82",
"md5": "234867160d371e820238134bf1402b46",
"sha256": "290fecc0e828f11aa3bcc351dda9512a1ac9ab63283dd2788627ff906e0bf319"
},
"downloads": -1,
"filename": "aqsc-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "234867160d371e820238134bf1402b46",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 129866,
"upload_time": "2024-02-08T15:44:09",
"upload_time_iso_8601": "2024-02-08T15:44:09.782378Z",
"url": "https://files.pythonhosted.org/packages/3d/2e/976b75fd6ff6fdafe1b6e2056312587d3eac3507816d55fb9a61b7383c82/aqsc-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9cf75c55e581aa09539a252a52121628ccd6ab41b81b5cabea37b1a5f62ce10b",
"md5": "1da5ef936791fe930ff362c465ac6e97",
"sha256": "1a4fed2e917ac447fbf6f4ffae48ab13c1379652940ca4722e50345467e06d9a"
},
"downloads": -1,
"filename": "aqsc-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "1da5ef936791fe930ff362c465ac6e97",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 129511,
"upload_time": "2024-02-08T15:44:11",
"upload_time_iso_8601": "2024-02-08T15:44:11.833841Z",
"url": "https://files.pythonhosted.org/packages/9c/f7/5c55e581aa09539a252a52121628ccd6ab41b81b5cabea37b1a5f62ce10b/aqsc-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-08 15:44:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lankef",
"github_project": "pyAQSC",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "aqsc"
}
