constellaration 0.1.2__tar.gz

constellaration-0.1.2/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

constellaration-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present Proxima Fusion Gmbh <info@proximafusion.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

constellaration-0.1.2/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: constellaration
+Version: 0.1.2
+Summary: Code for analyzing and evaluating stellarator plasma shapes
+Project-URL: Documentation, https://github.com/proximafusion/constellaration#readme
+Project-URL: Issues, https://github.com/proximafusion/constellaration/issues
+Project-URL: Source, https://github.com/proximafusion/constellaration
+Author-email: Maria Pascu <mariap@proximafusion.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.9
+Requires-Dist: booz-xform==0.0.8
+Requires-Dist: ipython
+Requires-Dist: jaxtyping
+Requires-Dist: matplotlib==3.9.2
+Requires-Dist: nbformat
+Requires-Dist: numpy==2.1.3
+Requires-Dist: plotly
+Requires-Dist: pydantic
+Requires-Dist: pymoo==0.6.1.3
+Requires-Dist: qicna==0.3.4
+Requires-Dist: scipy
+Requires-Dist: simsopt==1.8.1
+Requires-Dist: vmecpp==0.4.2
+Description-Content-Type: text/markdown
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/978b76bc-cd9b-4af8-b1f3-18efde7c079f">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/ec4e391a-9044-44ae-93f0-9dd8bed70001">
+  <img alt="A dark Proxima logo in light color mode and a light one in dark color mode." src="https://github.com/user-attachments/assets/ec4e391a-9044-44ae-93f0-9dd8bed70001" width=400px>
+</picture>
+
+# ConStellaration: A dataset of QI-like stellarator plasma boundaries and optimization benchmarks
+
+ConStellaration is a dataset of diverse QI-like stellarator plasma boundary shapes, paired with their ideal-MHD equilibria and performance metrics.  
+The dataset is available on [Hugging Face](https://huggingface.co/datasets/proxima-fusion/constellaration).  
+The repository contains a suite of tools and notebooks for exploring the dataset, including a forward model for plasma simulation and scoring functions for optimization evaluation.
+
+## Installation
+
+The following instructions have been tested on **Ubuntu 22.04**. Other platforms may require additional steps and have not been validated.
+
+The system dependency `libnetcdf-dev` is required for running the forward model. On Ubuntu, please ensure it is installed before proceeding, by running:
+
+  ```bash
+  sudo apt-get install libnetcdf-dev
+  ```
+
+1. Clone the repository:
+
+  ```bash
+  git clone https://github.com/proximafusion/constellaration.git
+  cd constellaration
+  ```
+
+2. Install the required Python dependencies:
+
+  ```bash
+  pip install .
+  ```
+
+### Install directly from GitHub
+
+To install the package directly from the GitHub repository without cloning, ensure the system dependency is installed first, then run:
+
+```bash
+pip install git+https://github.com/proximafusion/constellaration.git
+```
+
+### Running with Docker
+
+If you prefer not to install system dependencies, you can use the provided Dockerfile to build a Docker image and run your scripts in a container.
+
+1. Build the Docker image:
+
+  ```bash
+  docker build -t constellaration .
+  ```
+
+2. Run your scripts by mounting a volume to the container:
+
+  ```bash
+  docker run --rm -v $(pwd):/workspace constellaration python relative/path/to/your_script.py
+  ```
+
+Replace `your_script.py` with the path to your script. The `$(pwd)` command mounts the current directory to `/workspace` inside the container.
+
+## Explanation Notebook
+
+You can explore the functionalities of the repo through the [Boundary Explorer Notebook](./notebooks/boundary_explorer.ipynb).
+
+## Citation
+
+If you find this work useful, please cite us:

constellaration-0.1.2/README.md

@@ -0,0 +1,68 @@
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/978b76bc-cd9b-4af8-b1f3-18efde7c079f">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/ec4e391a-9044-44ae-93f0-9dd8bed70001">
+  <img alt="A dark Proxima logo in light color mode and a light one in dark color mode." src="https://github.com/user-attachments/assets/ec4e391a-9044-44ae-93f0-9dd8bed70001" width=400px>
+</picture>
+
+# ConStellaration: A dataset of QI-like stellarator plasma boundaries and optimization benchmarks
+
+ConStellaration is a dataset of diverse QI-like stellarator plasma boundary shapes, paired with their ideal-MHD equilibria and performance metrics.  
+The dataset is available on [Hugging Face](https://huggingface.co/datasets/proxima-fusion/constellaration).  
+The repository contains a suite of tools and notebooks for exploring the dataset, including a forward model for plasma simulation and scoring functions for optimization evaluation.
+
+## Installation
+
+The following instructions have been tested on **Ubuntu 22.04**. Other platforms may require additional steps and have not been validated.
+
+The system dependency `libnetcdf-dev` is required for running the forward model. On Ubuntu, please ensure it is installed before proceeding, by running:
+
+  ```bash
+  sudo apt-get install libnetcdf-dev
+  ```
+
+1. Clone the repository:
+
+  ```bash
+  git clone https://github.com/proximafusion/constellaration.git
+  cd constellaration
+  ```
+
+2. Install the required Python dependencies:
+
+  ```bash
+  pip install .
+  ```
+
+### Install directly from GitHub
+
+To install the package directly from the GitHub repository without cloning, ensure the system dependency is installed first, then run:
+
+```bash
+pip install git+https://github.com/proximafusion/constellaration.git
+```
+
+### Running with Docker
+
+If you prefer not to install system dependencies, you can use the provided Dockerfile to build a Docker image and run your scripts in a container.
+
+1. Build the Docker image:
+
+  ```bash
+  docker build -t constellaration .
+  ```
+
+2. Run your scripts by mounting a volume to the container:
+
+  ```bash
+  docker run --rm -v $(pwd):/workspace constellaration python relative/path/to/your_script.py
+  ```
+
+Replace `your_script.py` with the path to your script. The `$(pwd)` command mounts the current directory to `/workspace` inside the container.
+
+## Explanation Notebook
+
+You can explore the functionalities of the repo through the [Boundary Explorer Notebook](./notebooks/boundary_explorer.ipynb).
+
+## Citation
+
+If you find this work useful, please cite us:

constellaration-0.1.2/constellaration/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2025-present Proxima Fusion GmbH <info@proximafusion.com>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "0.1.2"

constellaration-0.1.2/constellaration/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2025-present Proxima Fusion GmbH <info@proximafusion.com>
+#
+# SPDX-License-Identifier: MIT