simcats-datasets 2.5.0__py3-none-any.whl → 2.6.0__py3-none-any.whl

simcats_datasets-2.6.0.dist-info/METADATA

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: simcats-datasets
+Version: 2.6.0
+Summary: SimCATS-Datasets is a Python package that simplifies the creation and loading of SimCATS datasets. 
+Author-email: Fabian Hader <f.hader@fz-juelich.de>, Fabian Fuchs <f.fuchs@fz-juelich.de>, Karin Havemann <k.havemann@fz-juelich.de>, Sarah Fleitmann <s.fleitmann@fz-juelich.de>, Jan Vogelbruch <j.vogelbruch@fz-juelich.de>
+License-Expression: GPL-3.0-or-later
+Project-URL: homepage, https://github.com/f-hader/SimCATS-Datasets
+Project-URL: documentation, https://simcats-datasets.readthedocs.io
+Project-URL: source, https://github.com/f-hader/SimCATS-Datasets
+Project-URL: tracker, https://github.com/f-hader/SimCATS-Datasets/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: bezier
+Requires-Dist: bm3d
+Requires-Dist: h5py
+Requires-Dist: hdf5storage
+Requires-Dist: numpy
+Requires-Dist: opencv-python
+Requires-Dist: pandas
+Requires-Dist: parallelbar
+Requires-Dist: parse
+Requires-Dist: scikit-image
+Requires-Dist: simcats>=2.0.0
+Requires-Dist: torch
+Requires-Dist: tqdm
+Requires-Dist: xarray
+Dynamic: license-file
+
+<h1 align="center">
+  <img src="https://raw.githubusercontent.com/f-hader/SimCATS-Datasets/main/SimCATS-Datasets_symbol.svg" alt="SimCATS logo">
+  <br>
+</h1>
+
+<div align="center">
+  <a href="https://github.com/f-hader/SimCATS-Datasets/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/License-GPLv3-blue.svg" alt="License: GPLv3"/>
+  </a>
+  <a href="https://pypi.org/project/simcats-datasets/">
+    <img src="https://img.shields.io/pypi/v/simcats-datasets.svg" alt="PyPi Latest Release"/>
+  </a>
+  <a href="https://simcats-datasets.readthedocs.io/en/latest/">
+    <img src="https://img.shields.io/readthedocs/simcats-datasets" alt="Read the Docs"/>
+  </a>
+  <a href="https://doi.org/10.1109/TQE.2024.3445967">
+    <img src="https://img.shields.io/badge/DOI (SimCATS Paper)-10.1109/TQE.2024.3445967-007ec6.svg" alt="DOI Paper"/>
+  </a>
+  <a href="https://doi.org/10.5281/zenodo.13862231">
+    <img src="https://img.shields.io/badge/DOI (Code)-10.5281/zenodo.13862231-007ec6.svg" alt="DOI Code"/>
+  </a>
+</div>
+
+# SimCATS-Datasets
+
+`SimCATS-Datasets` is a Python package that simplifies the creation and loading of `SimCATS` datasets. Please have a look at 
+[this repository](https://github.com/f-hader/SimCATS) regarding `SimCATS` itself.
+
+## Installation
+
+The framework supports Python versions 3.7 - 3.11 and installs via pip:
+```
+pip install simcats-datasets
+```
+
+Alternatively, the `SimCATS-Datasets` package can be installed by cloning the GitHub repository, navigating to the
+folder containing the `setup.py` file, and executing
+```
+pip install .
+```
+
+For installation in development/editable mode, use the option `-e`.
+
+<!-- start sec:documentation -->
+## Documentation
+
+The official documentation is hosted on [ReadtheDocs](https://simcats-datasets.readthedocs.io) but can also be built
+locally. To do this, first install the packages `sphinx`, `sphinx-rtd-theme`, `sphinx-autoapi`, `myst-nb `, and 
+`jupytext` with
+
+```
+pip install sphinx sphinx-rtd-theme sphinx-autoapi myst-nb jupytext
+```
+
+and then, in the `docs` folder, execute the following command:
+
+```
+.\make html
+```
+
+To view the generated HTML documentation, open the file `docs\build\html\index.html`.
+<!-- end sec:documentation -->
+
+
+## Loading Datasets
+
+Datasets created with `SimCATS-Datasets` are stored in HDF5 files. These datasets can be loaded using the function 
+`load_dataset` from `simcats_datasets.loading`.
+
+The return value of the function is a named tuple. The fields can be accessed by their name or index. As with normal
+tuples, it is also possible to unpack the returned fields directly into separate variables. The available fields 
+depend on which data was specified to be loaded. Please look at the docstring for further information.
+
+Additionally, `SimCATS-Datasets` offers a pytorch dataset (see `torch.utils.data.Dataset`) implementation called 
+`SimcatsDataset`. It allows the direct use of `SimCATS` datasets for machine learning purposes with Torch and can be 
+imported from `simcats_datasets.loading.pytorch`.
+
+## Creating Datasets
+
+To create a simulated dataset, import `create_simulated_dataset` from `simcats_datasets.generation`. This function
+allows the creation of simulated CSDs with ground truth very easily. It is also possible to add further CSDs to already
+existing datasets. The function will detect the existing dataset automatically. For the function's usage, please have a
+look at its docstring. 
+
+| :warning: WARNING                                                                                                                                                                                                                                                                                                        |
+|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| The functionalities for creating and extending simulated datasets using SimCATS expect that the SimCATS simulation uses the IdealCSDInterface implementation called IdealCSDGeometric. Other implementations might cause problems because the expected information for creating labeled lines etc. might be unavailable. |  
+
+
+Alternatively, to using `create_simulated_dataset` and directly simulating a dataset with `SimCATS`, it is also possible 
+to create a `SimCATS-Dataset` compatible dataset with existing data (for example, experimentally measured data or data 
+simulated with other frameworks). This can be done using `create_dataset` from `simcats_datasets.generation`.
+
+## Citations
+
+```bibtex
+@article{hader2024simcats,
+  author={Hader, Fabian and Fleitmann, Sarah and Vogelbruch, Jan and Geck, Lotte and Waasen, Stefan van},
+  journal={IEEE Transactions on Quantum Engineering}, 
+  title={Simulation of Charge Stability Diagrams for Automated Tuning Solutions (SimCATS)}, 
+  year={2024},
+  volume={5},
+  pages={1-14},
+  doi={10.1109/TQE.2024.3445967}
+}
+```
+
+## License, CLA, and Copyright
+
+[![CC BY-NC-SA 4.0][gplv3-shield]][gplv3]
+
+This work is licensed under a
+[GNU General Public License 3][gplv3].
+
+[![GPLv3][gplv3-image]][gplv3]
+
+[gplv3]: https://www.gnu.org/licenses/gpl-3.0.html
+[gplv3-image]: https://www.gnu.org/graphics/gplv3-127x51.png
+[gplv3-shield]: https://img.shields.io/badge/License-GPLv3-blue.svg
+
+Contributions must follow the Contributor License Agreement. For more information, see the [CONTRIBUTING.md](https://github.com/f-hader/SimCATS-Datasets/blob/main/CONTRIBUTING.md) file at the top of the GitHub repository.
+
+Copyright © 2026 Peter Grünberg Institute - Integrated Computing Architectures (ICA / PGI-4), Forschungszentrum Jülich GmbH

simcats_datasets-2.6.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+simcats_datasets/__init__.py,sha256=CGdvmMJ1FurXbest3M1UNpqxe3IPeIGGoUgoSHbViRQ,37
+simcats_datasets/generation/__init__.py,sha256=yjmfaDuZVqAD2EhLkmNIP1HEiuPTXgBIZVhBO8otGTE,344
+simcats_datasets/generation/_create_dataset.py,sha256=0La9eIqFIYxg6HypjhO7TpXdgJBzqkcp_KGIn9PklbU,19947
+simcats_datasets/generation/_create_simulated_dataset.py,sha256=Mt8jU7bfeUrsqVAeZnrJ-q_J-JDoONL6OxjLW_QgOak,24603
+simcats_datasets/loading/__init__.py,sha256=KiaJAJX0uIBg_bbZ8yYmolanfd6oV8JbOBxnct3U3TQ,287
+simcats_datasets/loading/_load_dataset.py,sha256=gVqe7HHg4OixRMZo8tn1oMXTliWyPE3Tje9Ra9RFnmQ,12207
+simcats_datasets/loading/load_ground_truth.py,sha256=4MVbusWOeIzz4aoTOk7x2ux-gywGTgZaVDh8naMDMhs,45268
+simcats_datasets/loading/pytorch.py,sha256=P8FLmQRIrzbwYnQe0yWKJRFFjjZdVdxbeGT36XfOdus,28990
+simcats_datasets/support_functions/__init__.py,sha256=mWmt41IjosziXPd86JiR-O7A_k06IMnYej2h1YsNMUo,73
+simcats_datasets/support_functions/_json_encoders.py,sha256=BZrVXtUqwmqT0ki-jnWraYUnNMy0l18tJWdFjzJSgqg,1435
+simcats_datasets/support_functions/clip_line_to_rectangle.py,sha256=120YsOAbqSoB5uC45NLWfiZx4G5JwBAN5zFQCoU4dJc,9399
+simcats_datasets/support_functions/convert_lines.py,sha256=qD1faASp4p6JwjMLyXYvUq-rcLVCc2oH5_duA3U-uFo,6534
+simcats_datasets/support_functions/data_preprocessing.py,sha256=yBUsQJvpl3_ivJXUH48bgXi_yRF55G05Sj9ADtKonyI,17611
+simcats_datasets/support_functions/get_coulomb_oscillation_area_boundaries.py,sha256=l9-AbFYYHIFV4ADGLXxyJUBDISQ_9AhUk4RtQK678JE,26862
+simcats_datasets/support_functions/get_lead_transition_labels.py,sha256=-TnTxmJuxokD1Vprb9-IuE62Ys82HvlJ8VEQXCx7tY0,5691
+simcats_datasets/support_functions/metadata_utils.py,sha256=d4f7fCdoOft74GZywRXt1AQaSQ5MwILqaIomCrp9rTI,2479
+simcats_datasets/support_functions/pytorch_format_output.py,sha256=o6v73-s-u8YhPmeZxtxLpBKQ4dRasnHard9DoMlEUpI,8337
+simcats_datasets-2.6.0.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+simcats_datasets-2.6.0.dist-info/METADATA,sha256=gaY2C_Fck0ohMcB0DP-87V0hHDTgGLU0ZJUV4rdwT1w,7653
+simcats_datasets-2.6.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+simcats_datasets-2.6.0.dist-info/top_level.txt,sha256=6PQ9YF0TvHYNZHES-hfT1RCExihiv4o5J_O2JyYea74,17
+simcats_datasets-2.6.0.dist-info/RECORD,,

{simcats_datasets-2.5.0.dist-info → simcats_datasets-2.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any